Home
User Guide
The information contained in this section applies to WebSphere Commerce Version 8. The documentation also applies to all subsequent releases and modifications until otherwise indicated in a newer section.WebSphere Commerce is a single, unified e-commerce platform that offers the ability to do business directly with consumers (B2C), directly with businesses (B2B), and indirectly through channel partners (indirect business models). WebSphere Commerce is designed to be a customizable, scalable, and high availability solution that is built to leverage open standards. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels.
Deploying
The topics in this section describe how to publish stores to either a test or production environment, and how to deploy customized code.
WebSphere Commerce Build and Deployment tool
The WebSphere Commerce Build and Deployment tool is designed to address the error-prone and time-consuming nature of customized asset deployment. Manual customized asset deployment involves accessing and updating numerous systems, including your database, web server, application server, and WebSphere Commerce server. Manual customization can be problematic, especially for a production environment where downtime has a negative impact on the business. For a customization project with many developers, it is a challenge to ensure that each development environment setup is quick, easy, and repeatable to preserve productivity. The WebSphere Commerce Build and Deployment tool provides a starting point for you to automate your build and deployment processes in a standardized, controlled manner.
… customizing
Although the WebSphere Commerce Build and Deployment tool supports a wide range of configuration by default through samples and configurations, a WebSphere Commerce customization project may have very specific needs that are not easily supported. To tailor to such needs, the WebSphere Commerce Build and Deployment tool provides extension points which can be leveraged to develop customized build and deployment processes. This section provides customization guidelines and instructions.
Custom Ant tasks
The WebSphere Commerce Build and Deployment tool, in both the build and the deployment processes, uses custom Ant tasks.
FailNL task
Fails an Ant build with a national language (NL) message of the user locale, in the International Components for Unicode (ICU) format, which is identified by a given key from a resource bundle accessible from the class loader.

User Guide
The information contained in this section applies to WebSphere Commerce Version 8. The documentation also applies to all subsequent releases and modifications until otherwise indicated in a newer section.WebSphere Commerce is a single, unified e-commerce platform that offers the ability to do business directly with consumers (B2C), directly with businesses (B2B), and indirectly through channel partners (indirect business models). WebSphere Commerce is designed to be a customizable, scalable, and high availability solution that is built to leverage open standards. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels.
- Planning
  Creating a custom implementation of a WebSphere Commerce store requires a significant amount of planning. From gathering client needs, to deploying the live solution, much work is needed to successfully deploy a custom client store. Use the resources in here to help you plan every phase of store creation.
- Installing
  Review the following sections for information about installing the WebSphere Commerce product, associated maintenance, and WebSphere Commerce enhancements.
- Migrating
  Before you migrate to WebSphere Commerce Version 8.0, review this information to help plan and execute your migration.
- Deploying
  The topics in this section describe how to publish stores to either a test or production environment, and how to deploy customized code.
  - WebSphere Commerce Build and Deployment tool
    The WebSphere Commerce Build and Deployment tool is designed to address the error-prone and time-consuming nature of customized asset deployment. Manual customized asset deployment involves accessing and updating numerous systems, including your database, web server, application server, and WebSphere Commerce server. Manual customization can be problematic, especially for a production environment where downtime has a negative impact on the business. For a customization project with many developers, it is a challenge to ensure that each development environment setup is quick, easy, and repeatable to preserve productivity. The WebSphere Commerce Build and Deployment tool provides a starting point for you to automate your build and deployment processes in a standardized, controlled manner.
    - Prerequisites
      Before you begin, you must ensure that all prerequisites for the WebSphere Commerce Build and Deployment tool are met. In addition, you must learn about the current build, development, and deployment processes that are used in your project. Learning about the current processes helps in planning the adoption of the WebSphere Commerce Build and Deployment tool.
    - Location and file structure
      The WebSphere Commerce Build and Deployment tool is installed as part of the WebSphere Commerce product installation to WC_installdir/wcbd/. If you are installing WebSphere Commerce Developer, it is installed to WCDE_installdir/wcbd/.
    - … build process
      The WebSphere Commerce Build and Deployment tool is highly configurable, in order to suit your current server environment, repository structure, and target environments.
    - … server deployment process
      After you create the deployment package, you can deploy it using additional Ant scripts provided as part of the WebSphere Commerce Build and Deployment tool.
    - … toolkit deployment process
      After you create the deployment package, you can deploy it to your development environment using additional Ant scripts provided as part of the WebSphere Commerce Build and Deployment tool.
    - … customizing
      Although the WebSphere Commerce Build and Deployment tool supports a wide range of configuration by default through samples and configurations, a WebSphere Commerce customization project may have very specific needs that are not easily supported. To tailor to such needs, the WebSphere Commerce Build and Deployment tool provides extension points which can be leveraged to develop customized build and deployment processes. This section provides customization guidelines and instructions.
      - … build process
        Advanced users can customize the build process by using the Apache Ant scripting language.
      - … server deployment process
        Advanced users can customize the server deployment process by using the Apache Ant scripting language. This task guides you through creating your customization files for use with the WebSphere Commerce Build and Deployment tool.
      - … toolkit deployment process
        Advanced users can customize the toolkit deployment process by using the Apache Ant scripting language. This task guides you through creating your customization files for use with the WebSphere Commerce Build and Deployment tool.
      - Custom Ant tasks
        The WebSphere Commerce Build and Deployment tool, in both the build and the deployment processes, uses custom Ant tasks.
        ConfigureDeltaDeployment task
        Compares a baseline with a target for delta and prepares the delta source directory and delta configuration properties file accordingly. A delta summary file will also be created.
        ContainsInFileSet condition
        Checks whether a file is in the given file sets.
        DecodeLoadProperties task
        Decodes and loads the properties from a file that has been processed by the encodeProperties task. If the properties file contains properties that have not been encoded, they are loaded with values defined as-is.
        Dos2Unix task
        Converts newline characters of a file or a set of files from CRLF (DOS format) to CR (UNIX format). The conversion is done in binary so that it also works on files of different encoding.
        EchoNL task
        Echoes national language (NL) message of the user locale, in the International Components for Unicode (ICU) format, which is identified by a given key from a resource bundle accessible from the class loader.
        EditPropertiesFile task
        Edits the properties in a properties file.
        EncodeProperties task
        Encodes and saves the properties in a properties file. This task is safe to run on the same properties file multiple times, as properties that have previously been encoded are not re-encoded. If a property value needs to be changed, replace the encoded value with the new value in plain text and rerun this task.
        FailNL task
        Fails an Ant build with a national language (NL) message of the user locale, in the International Components for Unicode (ICU) format, which is identified by a given key from a resource bundle accessible from the class loader.
        NumberCompare condition
        Compares two numbers of subclass of java.lang.Number.
        PrintStackTrace task
        Sets the stack trace of a java.lang.Throwable object to a property. This task is intended to be used in conjunction with the tryCatch task provided by Ant-Contrib.
        SetSystemProperty task
        Sets a system property.
        StringLengthCompare condition
        Compares the length of a string with a set length.
        ToURI task
        Constructs the Uniform Resource Identifier (URI) for a file and sets it to a property.
        ValidateProperty task
        Validates the value of a property on whether it is set, whether the value is empty, or against a list of possible values, and fails the Ant build when validation fails.
  - Managed asset deployment
    Managed assets are files that are uploaded by business users to be used for store marketing, or to supplement products. They are added to WebSphere Commerce through the Assets tool or the Marketing tool in Management Center. By default, managed assets are extracted and deployed through the WebSphere Commerce EAR. To maintain performance in a large-scale production environment, site administrators must switch to alternative extraction and deployment methods for managed assets.
  - Deploying customized assets
    When you deploy customized assets for WebSphere Commerce, consider the two stages: packaging and deploying.
  - Minimizing downtime during deployment
    Your WebSphere Commerce site is an integral part of your company's revenue flow, so disruptions and any downtime should be minimized. Moreover, taking down a site for long periods of time or frequently, reflects on the store's credibility and impacts the customer's shopping experience with and potential return visits to the site.
  - How to increase your success with WebSphere Commerce deployment
    Use these tips and best practices to help you successfully deploy WebSphere Commerce.
  - WebSphere Commerce deployment checklist
    The WebSphere Commerce deployment checklist is based on lessons learned from IBM internal groups, external customers and business partners deploying WebSphere Commerce-based solutions. This checklist is intended to provoke discussion; it is not a detailed set of instructions.
  - Publishing a store archive
    Publishing a store archive to a WebSphere Commerce Server allows you to create a running store. You have two options for publishing a store archive: Publishing a store archive using the Publish wizard, Publishing a store archive using the publishstore utility.
- Operating
- Integrating
  Topics in the Integrating category highlight the tasks that are commonly performed for using WebSphere Commerce in combination with other products.
- Administering
- Tutorials
  WebSphere Commerce provides many tutorials to help you customize and understand your WebSphere Commerce instance and stores.
- Samples
- Developing
  The topics in the Developing section describe tasks performed by an application developer.
- Compliance
  The following section describes how you can leverage WebSphere Commerce features and functionality to help your site be compliant with different privacy and security standards.
- Securing
  These topics describe the security features of WebSphere Commerce and how to configure these features.
- Performance
- Troubleshooting

FailNL task

Fails an Ant build with a national language (NL) message of the user locale, in the International Components for Unicode (ICU) format, which is identified by a given key from a resource bundle accessible from the class loader.

Parameters

The following table describes the FailNL task parameters.
Attribute	Description	Required
bundle	The resource bundle to load properties from.	Yes
key	The key of the property to be loaded from the resource bundle.	Yes
if	The name of the property for which if set, this task will cause a build failure.	No; Only one of these properties or the nested `Condition` element may be specified
unless	The name of the property for which if not set, this task will cause a build failure.

Nested elements

Arg

Specifies an argument with which patterns in the message are replaced.


Attribute	Description	Required
value	The value of the argument.	Yes

Condition: Specifies the condition for which if it is met, this task will cause a build failure. Refer to Conditions in the Apache Ant manual for a list of conditions that can be used in this nested element.

Examples

The following example fails the Ant build with an NL message of the user locale that is identified by the ERR_WSADMIN property of the wcbd-deploy-messages resource bundle accessible from the class loader.

<failNL bundle="wcbd-deploy-messages" key="ERR_WSADMIN" />

The following example fails the Ant build with an NL message of the user locale that is identified by the ERR_XMLTRANSFORM property of the wcbd-deploy-messages resource bundle accessible from the class loader, while substituting the {0} pattern in the message with the value of the wca.logger.output.dir property.

<failNL bundle="wcbd-deploy-messages" key="ERR_XMLTRANSFORM">
    <arg value="${wca.logger.output.dir}" />
</failNL>

The following example fails the Ant build with an NL message of the user locale that is identified by the ERR_FILE_NOT_FOUND property of the wcbd-build-messages resource bundle accessible from the class loader, while substituting the {0} pattern in the message with ${basedir}/build.properties, if the file ${basedir}/build.properties does not exist.

<failNL bundle="wcbd-build-messages" key="ERR_FILE_NOT_FOUND">
 <arg value="${basedir}/build.properties" />
   <condition>
    <not>
     <available file="${basedir}/build.properties" type="file" />
    </not>
   </condition>
</failNL>