Location and file structure of the HCL Commerce Build tool
In the HCL Commerce development environment, the HCL Commerce Build tool (WCB tool) is found in the WCDE_installdir/wcbd/ directory. In the HCL Commerce runtime environment, the HCL Commerce Build tool is found in the Utility server Docker container at /opt/WebSphere/CommerceServer90/wcbd.
Important: Beginning in HCL Commerce 9.1.14.0, application container images are built to be run
as a non-root user by default. This change has the potential to break your
custom deployment. Therefore, you must review this change and its potential
impacts. For more information, see HCL Commerce container users and privileges.Description of the HCL Commerce Build tool installation directory file structure
The following table describes the file structure
of the HCL Commerce Build tool installation directory:
| Path | Type | Description |
|---|---|---|
| dist/server | Directory | Contains the server deployment packages that are generated by the build process. Created when the build process is run. |
| extract | Directory | Contains templates and sample files for the source extraction Ant script. |
| lib | Directory | Contains the Java libraries that are required by the build and deployment processes. |
| logs | Directory | Contains the build logs. Created when the build process is run. |
| project-templates | Directory | Contains the project templates for the StaticWeb project. |
| properties | Directory | Contains the translated message properties file used by the build process. |
| source | Directory | Contains the source code that is copied or extracted from the SCM by the build process. Created when the build process is run. |
| working | Directory | Contains intermediary or temporary assets that are generated by the build process. Created when the build process is run. |
| wcbd-ant | File | The shell script that launches Ant to start the build process. |
| wcbd-ant.bat | File | The batch file that launches Ant to start the build process. |
| wcbd-build.private.properties.template | File | The template for the configuration properties file that contains security-sensitive information of the build process (for example, passwords). Properties in this file are encoded by the build process. |
| wcbd-build.properties.template | File | The template for the main configuration properties file of the build process. |
| wcbd-build.xml | File | The default Ant build file that controls the overall build process. |
| wcbd-build-common.xml | File | The Ant build file that contains reusable targets for the build process. |
| wcbd-encode-properties | File | The shell script that launches Ant to encode a properties file. |
| wcbd-encode-properties.bat | File | The batch file that launches Ant to encode a properties file. |
| wcbd-encode-properties.xml | File | The Ant build file that encodes a properties file. |
| wcbd-setenv*.template | File | The templates for the batch file or shell script that sets environment variables that are required by the build process. |
| wcbd-version-info.properties | File | The properties file that provides version information of the HCL Commerce Build tool. |
| wcbd-build-search-classpath.xml | File | The Ant build file that sets the HCL Commerce Search classpath. |
| wcbd-build-crs-definition.properties | File | The properties file that provides the type of application and the Ant target to use for deploying to the CRS. |
| wcbd-build-shared-classpath.xml | File | The Ant build file that sets the shared HCL Commerce and HCL Commerce Search class paths. |
| wcbd-build-wc-ts-definition.properties | File | The properties file that provides the type of application and the Ant target to use for deploying to the Transaction Server EAR. |
| wcbd-build-crs-definition.properties | File | The properties file that provides the type of application and the Ant target to use for deploying to the Remote Store Server EAR. |
| wcbd-build-search-definition.properties | File | The properties file that provides the type of application and the Ant target to use for deploying to the Search Server EAR. |
| wcbd-build-xc-definition.properties | File | The properties file that provides the type of application and the Ant target to use for deploying to the External Customization Server EAR. |
| wcbd-build-data-definition.properties | File | The properties file that provides the type of application and Ant target to use for packaging data and schema changes. |
Working directory in the Utility server Docker container container
If you run the HCL Commerce Build tool from the Utility server Docker container, put any files that could be changed into a separate volume mounted to the container as a writable directory. Place all configuration property files used to run the HCL Commerce Build tool in this directory.
Set the output directory of the build to a sub-directory in this volume. The configuration key is dist.dir which can be found in wcbd-build-type-app-type.properties. The benefit of doing this is that when you upgrade the Utility server Docker image, the configuration files in the other volume are not lost. You need only again mount the volume to the new Docker container.
When you execute the build command, use the Java parameter
work.dir to specify the volume mount , for example:
./wcbd-ant -buildfile wcbd-build.xml -Dbuild.type=local -Dapp.type=ts -Dbuild.label=testrun -Dwork.dir=mounted_dir