Assembling and Deploying an ATG Merchandising Application

Before you start ATG Merchandising, you need to build a J2EE application that contains an instance of the modules used by ATG Merchandising. Once you’ve assembled your application, deploy the application and start it according to the instructions provided in your application server documentation.

The ATG platform provides an assembly tool that you can use to create your J2EE application. For more information, see the ATG Programming Guide.

To assemble a J2EE application that includes ATG Merchandising, you execute a command in this format:

<ATG9dir>/home/bin/runAssembler [options] output-file-name
[-layer config-layer-list] –m module-list

When you build an application that you intend to run with ATG Merchandising, you need to include the following:

  • DCS-UI module or a submodule of it

  • PubPortlet module

  • A commerce module that represents a commerce product, such as B2CCommerce.Versioned or B2BCommerce.Versioned, or a type of catalog (custom or standard)

  • The -layer Staging switch, if your environment includes a staging target.

    For more information about deployment targets, see the ATG Content Administration Programming Guide.

  • The -layer Preview switch, if you want to be able to preview catalog data

    For more information on setting up preview, see the Setting Up Preview chapter in the ATG Business Control Center Administration and Development Guide.

    Note: Faceted Search and Search Merchandising are currently not supported for preview. For information on testing search results, see Testing Search Queries.

  • Modules that support the integration of ATG Search, ATG Merchandising, and ATG Commerce, if you have all three products

    For a list of modules, see ATG Merchandising Modules.

  • Other modules you’ve created that contain your custom code

When you build your application, the ATG Commerce module you use indicates the type of commerce product (ATG Consumer Commerce or ATG Business Commerce) or the type of catalogs (standard or custom) your site implements as well as other optional ATG Commerce features. Applications that use custom catalogs must specify the DCS.DynamicCustomCatalogs.Versioned module when running ATG Merchandising. This module is included when you use the B2BCommerce.Versioned module.

For example, if you want your application to include ATG Merchandising, ATG Content Administration, and ATG Consumer Commerce using custom catalogs, you can use the following command:

<ATG9dir>/home/bin/runAssembler MyApp.ear -m DCS-UI.management
PubPortlet B2BCommerce.Versioned

where MyApp.ear is your application packaged as a J2EE archive file. This command assumes that you do not use any custom modules or additional ATG modules. Only the modules mentioned here and those accessed by them are included in the EAR file. Remember that you can start only the modules that are included in your J2EE application, so if you designate only one module during assembly, you won’t be able to start other modules without assembling a new J2EE application.

Here’s an example of the command you’d use to run ATG Search with Consumer Commerce, so you can use Faceted Search and Search Merchandising:

<ATG9dir>/home/bin/runAssembler MyApp.ear -m DCS-UI.Search
PubPortlet B2CCommerce.Versioned DCS.Search.Versioned

The corresponding ATG Business Commerce command is as follows:

<ATG9dir>/home/bin/runAssembler MyApp.ear -m DCS-UI.Search PubPortlet
B2BCommerce.Versioned DCS.Search.CustomCatalogs.Versioned

For information on how to deploy your J2EE application, see the documentation from your application server vendor.

 
loading table of contents...