Configure packaging settings

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


Task info

.properties files determine what gets packaged when you running the WCB utility. We need different properties files for the different types of packages that we intend to build. We 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.

For a custom repository structure, use settings appropriate to the environment. The file WCB_sample.zip provides sample properties files and an xC sample.

(Linux) In 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. For WebSphere Commerce Developer set ANT_HOME and WAS_HOME environment variables.

    1. Copy..

      ...as...

    2. Open WCB_installdir/setenv.bat with a text editor and set the following values:

    (Linux) 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...

      ...as...

      ...where buildtype and apptype are the values to use for build.type and app.type when building the package with wcbd-ant.bat.

        app.type
        The application 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 we are getting files from a local system to build a package for search customizations, name the file build-local-search.private.properties.

      • If we are getting files from an external SCM system to build a package for store customizations, name the file build-git-crs.private.properties

      (Linux)

      Note: Alternatively, we 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 using the forward slash '/' as the file separator, even for Windows systems.

      (Linux) If 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...

      ...as...

      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.

      Ensure using the forward slash '/' as the file separator, even for Windows systems.

      (Linux) If 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.


Related concepts
Sample WebSphere Commerce Build tool configuration
WebSphere Commerce Build tool repository structure
Advanced build features


Related tasks
Setting up source extraction Ant script
Building packages


Related reference
Build configuration references