Voyez le cloud autrement

Assembling ATG Commerce Reference Store For Preview

by Vina Rakotondrainibe | Oracle Commerce Expert and Cloud Deployment Specialist
Paris area,


Oracle Commerce comes with a demo store called Commerce Reference Store which is used as a quickstarter for projects or just for demoing the solution. This application supports Oracle Guided Search (formerly Endeca) integration but it is not really clear what you have to do to deploy the demo application on a standalone server.

I will assume that you already know how to configure Oracle Commerce and Nucleus components. When you are deploying ATG on a standalone server as an EAR, you can override any service configuration by placing files in the ATG-Data folder which is created when the application starts.

Module list

When you run CIM to configure your development installation, it generates a file containing the module list in the servers directory. Suppose your server name is front, the module list file will be generated in the

file. You need this module list to assemble your EAR (see the ${DYNAMO_MODULES} environment parameter in the next section).

Assembling the EAR

To build the EAR, issue the following command:

bin/runAssembler -pack -standalone -liveconfig -jboss preview.ear -layer endecapreview -m ${DYNAMO_MODULES}

The endecapreview configuration layer contains specific settings to turn your instance into a preview instance with specific behaviour for Endeca contents and rules processing.

Configuring File Store on Oracle Commerce

In the live environment, the reference store uses the zip file created by the Endeca content promotion script. You certainly remember that during the product installation and configuration, the CIM tool asked for a shared folder to use between the Workbench and ATG. This is why you need this shared space.

For preview, you can configure Oracle Commerce to download all the necessary files from the Authoring Workbench.

Let's assume your ATG-Data folder is located under /srv/atg/ATG-Data and that your server name is preview . You need to create a properties file as follows to override the default settings:

cd /srv/atg/ATG-Data/servers/preview/localconfig
mkdir -p atg/endeca/assembler/cartridge/manager
cd atg/endeca/assembler/cartridge/manager

The content of this file should indicate that there is no default file store. The content source component switches automatically to an instance of com.endeca.infront.content.source.EcrStoreFactory.


Save the properties file and restart the server.

On the Oracle Commerce Administration console (a.k.a dyn/admin ), check that the storeFactory property of the /atg/endeca/assembler/cartridge/manager/DefaultWorkbenchContentSource service is now an instance of EcrStoreFactory and that both the host and serverPort properties are referencing the host where you installed the Endeca authoring Tools and Framework product on port 8007 (the default).

Note: It is not recommended to switch to this mode for live instances as downloading the configuration files directly from the Workbench can be resource intensive (network and CPU).

Configuring the preview URL for the ATG Assembler (updated on 1/2/2015)

If you have put the Experience Manager behind a proxy of if the alias name you are accessing the Experience Manager is different from the Workbench server's host name, you will need to update the previewModuleUrl property of the /atg/endeca/assembler/cartridge/manager/AssemblerSettings service:

previewModuleUrl=http://<your alias name>/ifcr

Configuring REST for Experience Manager calls on Oracle Commerce

When in Experience Manager, you can attach ATG User segments to cartridges to limit the content display scope. For that to work, you need to configure ATG REST security correctly.

Step 1: On the Workbench machine (Endeca Tools and Framework), execute the following command

cd ${ENDECA_TOOLS_ROOT}/credential_store/bin
./ add --User admin --config ${ENDECA_TOOLS_ROOT}/server/workspace/credential_store/jps-config.xml --type generic --mapName restService --key clientCredential

You will be prompted for a new password for the admin user. This password will be used to call the user segment preview instance (which should be the BCC server as per Oracle's recommendation).

Step 2: On the BCC instance server, add a credential map to the credential store:

Open the dyn/admin console and go to the /atg/dynamo/security/opss/csf/CredentialStoreManager service page.

Select "Create Generic Credential" from the dropdown menu. When you click on select, a form is displayed.

Enter the following data in the fields:

  • Map Name: requestCredentialMap
  • Credential Key Name: clientCredential
  • Enter Credential: the Password you used from the Tools and Framework configuration above