Build configuration properties
These properties provide general settings to the build process. The original template file for these properties is WCBD_installdir/wcbd-build.properties.template.
Property summary
| Property | Summary |
|---|---|
| application.type | The application where the WCBD build process packages and deploys assets. |
| 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 that is 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 that are packaged into the modules. |
| connector.module.list | The comma-separated list of connector modules to be built. |
| 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 be built. |
| 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 be built. |
| 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 be built. |
| web.src.dir | The Java source directory of web modules. |
| web.bin.dir | The Java binary directory of web modules. |
| web.content.dir | The web content directory of web modules. |
| open.laszlo.web.module.list | The comma-separated list of OpenLaszlo web modules to be built. |
| open.laszlo.web.src.dir | The Java source directory of OpenLaszlo web modules. |
| open.laszlo.web.bin.dir | The Java binary directory of OpenLazlo web modules. |
| open.laszlo.web.content.dir | The web content directory of OpenLaszlo 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 that are 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 that is 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. |
| lzc.stack.size | The maximum Java thread stack size to be used by the OpenLaszlo compiler. |
| 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
application.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. Developers
can also separate the store WAR from the WebSphere Commerce EAR into
a separate store 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 new wcbd-build-classpath-application_type.xml are
created. The selected application type determines which class paths
the build process uses to compile and package the assets for deployment.
You can specify the following application types as the valid values
for this property:
- wc
- The WebSphere Commerce WC.ear application. The default value.
- search
- The WebSphere Commerce search Search.ear application.
- wcstores
- If the store WAR is separated from the WC.ear application, this value identifies the default separated store EAR application.
- 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. This property
is deprecated in favor of the more flexible ${ext.compile.class.path}.
- Default
- ${basedir}/ut-lib
- Deprecated
- 7.0.0.2
- 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,
you 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 and Deployment 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 that is 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 that are 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 be built. Leave
the value of this property empty if no such modules need to be built.
- 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 be built. Leave the
value of this property empty if no such modules need to be built.
- 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 be built.
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 be built. Leave the
value of this property empty if no such modules need to be built.
- Example
- SiteAdministration,Stores,TestWeb1
- web.src.dir
- The Java source directory of web modules.
- Default
- src
- 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
- open.laszlo.web.module.list
- The comma-separated list of OpenLaszlo web modules to be built.
Leave the value of this property empty if no such modules need to
be built.
- Example
- LOBTools
- open.laszlo.web.src.dir
- The Java source directory of OpenLaszlo web modules.
- Default
- src
- open.laszlo.web.bin.dir
- The Java binary directory of OpenLazlo web modules.
- Default
- ${web.content.dir}/WEB-INF/classes
- open.laszlo.web.content.dir
- The web content directory of OpenLaszlo 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 that are 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.
- Since
- 7.0.0.2
- wc.home
- The WebSphere Commerce or WebSphere Commerce Developer installation directory.
- was.home
- The WebSphere Application Server installation directory. If you are using Rational Application Developer V7.5 on the build system, set the value to RAD_installdir/runtimes/base_v7.
- 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
oracle
os400
- ejbdeploy.dbvendor
- 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 your 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 you 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
- Valid values
- DB2UDB_V95
- DB2UDB_V95
- ORACLE_V11G
- DB2UDBISERIES_V54
ejbdeploy.codegen- Whether the Java files generated by the ejbdeploy utility are
kept.
- Default
- false
- Since
- 7.0.0.3
- Valid values
- true
- false
- ejbdeploy.keep.generated
- Whether the working directory is kept after the ejbdeploy utility
completes.
- Default
- false
- Since
- 7.0.0.3
- 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
- Since
- 7.0.0.3
- Valid values
- true
- false
- ejbdeploy.no.validate
- Whether validation messages reported by the ejbdeploy utility
is suppressed.
- Default
- true
- Since
- 7.0.0.3
- Valid values
-
- true
- false
- ejbdeploy.trace
- Whether internal tracing for the ejbdeploy utility is enabled.
- Default
- false
- Since
- 7.0.0.3
- Valid values
- true
- false
- ejbdeploy.jvm.max.memory
- The maximum memory size to be used by the ejbdeploy utility.
- Default
- 256M
- Since
- 7.0.0.3
- run.extract
- Whether source code extraction is done.
- Default
-
true
- Valid values
- true
- false
- extract.ant.file
- The Ant build file that is 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.
- If you configured the source extraction Ant script with a sample before 7.0.0.3, you must reconfigure the scripts with the new sample for the appropriate SCM.
- Default
- false
- Since
- 7.0.0.3
- 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.
- lzc.stack.size
- The maximum Java thread stack size to be used by the OpenLaszlo
compiler. Set the value to be the corresponding value for the platform
that is running on the build system.
- Default
- -Xss192m
- Valid values
-Xss5m
-Xss7m
-Xss192m
- run.deploy.server
- Whether centralized server deployment runs.
- Default
- false
- Since
- 7.0.0.2
- 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
- Since
- 7.0.0.2
- deploy.server.target.env.list
- The comma-separated list of identifiers for target environments
against which centralized server deployment is run.
- Since
- 7.0.0.2
- 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
- Since
- 7.0.0.2
- 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
- Since
- 7.0.0.2
- run.clean.working.dir
- Whether the working directory is cleaned at the end of the build
process.
- Default
- false
- Since
- 7.0.0.3
- 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.