Configuring packaging settings

Before using the HCL Commerce Build tool, you must edit scripts and properties files to set important information such as file paths to software installations and module lists to be built.

About this task

The following steps guide you through configuring values in .properties files. These .properties files determine what gets packaged when you run the WCB utility. You need different properties files for the different types of packages that you intend to build. That is, you need to define a set of properties for packaging Transaction server updates, a set for building Store server updates, a set for building Search server updates, and a set for building Customization (xC) server updates.
Note: If you are using a custom repository structure, use settings appropriate to your environment.
The following WCB_sample.zip provides sample properties files that you can use as a reference to better understand what you need to configure. The WCB_sample.zip package also contains the xC sample.

LinuxIn the Utility server Docker container, some files can be placed into a mounted writable volume outside of the WCB_installdir. The mounted directory is referred to as mounted_dir in the following steps.

Procedure

  1. HCL Commerce Developer Set ANT_HOME and WAS_HOME environment variables.
    You only need to set these environment variables if you are using HCL Commerce Developer.
    1. Copy WCB_installdir/wcbd-setenv.bat.template as WCB_installdir/setenv.bat.
    2. Open WCB_installdir/setenv.bat with a text editor and set the following values:
      • ANT_HOME to Ant_installdir
      • WAS_HOME to WAS_installdir
      • WC_HOME to WC_installdir
    LinuxNote: The setenv script in the Utility server Docker container is already set to match the runtime environment. Only change the setenv script if you need to apply any customizations.
  2. Set security-sensitive build configurations.
    1. Copy WCB_installdir/wcbd-build.private.properties.template as WCB_installdir/build-buildtype-apptype.private.properties, where buildtype and apptype are the values you will will use for build.type and app.type when building the package with wcbd-ant.bat. For more information, see Building packages.
      app.type
      The application that you want to package.
      ts
      Build packages for the Transaction server.
      search
      Build packages for the Search server
      xc
      Build packages for the Customization server
      crs
      Build packages for the Store server
      data
      Build packages for the Data and Schema changes
      build.type
      local
      Retrieve files locally.
      svn
      Retrieve files from an Apache Subversion repository.
      cvs
      Retrieve files from a CVS repository.
      git
      Retrieve files from a Git repository.
      For example,
      • If you are getting files from a local system to build a package for search customizations, name the file build-local-search.private.properties.
      • If you are getting files from an external SCM system to build a package for store customizations, name the file build-git-crs.private.properties
      LinuxNote: Alternatively, you can copy the file to mounted_dir.
    2. Open the file with a text editor and configure the properties in the file by referring to the Security-sensitive build configuration properties topic.
      Note: Ensure that you use the forward slash '/' as the file separator, even for Windows systems.

      LinuxIf you copied the build-buildtype-apptype.private.properties file to the mounted_dir, then open that file.

  3. Set the packaging configurations that will be used in the packaging process.
    1. Copy WCB_installdir/wcbd-build.properties.template as WCB_installdir/build-buildtype-apptype.properties.

      For example, build-local-search.properties, build-git-crs.properties.

    2. Open the file with a text editor and configure the properties by referring to the Build configuration properties topic.
      Note:
      1. Ensure that you use the forward slash '/' as the file separator, even for Windows systems.
      2. wc.home and was.home are mandatory parameters and you must input correct paths for both. Other parameters can keep their defaults.

      LinuxIf you copied the build-buildtype-apptype.properties file to the mounted_dir, then open that file.

  4. Refer to the Advanced build features topic to learn about, and if applicable, apply features that suit your build needs.