This document describes a quick and easy way to install and play with ATG CRS. By following this guide, you'll be able to focus on learning about ATG CRS, without debugging common gotchas.
If you get lost, you can consult the ATG CRS Installation and Configuration Guide for help.
Throughout this document, the top-level directory that you checked out from git will be referred to as {ATG-CRS}
- Oracle Linux Server release 6.5 (Operating System) - All Licenses
- Oracle Database (choose either 11g or 12c)
- Oracle ATG Web Commerce 11.1 - license
- JDK 1.7 - Oracle BCL license
- ojdbc7.jar - driver OTN license
- Jboss EAP 6.1 - LGPL license
- Vagrant - MIT license
- VirtualBox - License FAQ - GPL
- vagrant-vbguest plugin - MIT license
- Oracle SQL Developer - license
This product stack is pretty heavy. It's a DB, three endeca services and two ATG servers. You're going to need:
- 16 gigs RAM
The CRS demo works with either Oracle 11g or Oracle 12c. Pick one and follow the download and provisioning instructions for the one you picked.
The first step is to download the required installers. In order to download Oracle database software you need an Oracle Support account.
- Go to Oracle Support
- Click the "patches and updates" tab
- On the left of the page look for "patching quick links". If it's not expanded, expand it.
- Within that tab, under "Oracle Server and Tools", click "Latest Patchsets"
- This should bring up a popup window. Mouse over Product->Oracle Database->Linux x86-64 and click on 11.2.0.4.0
- At the bottom of that page, click the link "13390677" within the table, which is the patch number
- Only download parts 1 and 2.
Even though it says it's a patchset, it's actually a full product installer.
IMPORTANT: Put the zip files parts 1 and 2, in the {ATG-CRS}/softwaredirectory at the top level of this project (it's the directory that has a readme.txtfile telling you how to use the directory).
- Go to Oracle Database Software Downloads
- Accept the license agreement
- Under the section "(12.1.0.2.0) - Enterprise Edition" download parts 1 and 2 for Linux x86-64
IMPORTANT: Put the zip files parts 1 and 2, in the {ATG-CRS}/softwaredirectory at the top level of this project (it's the directory that has a readme.txtfile telling you how to use the directory).
You will also need a way to connect to the database. I recommend Oracle SQL Developer.
These instructions download a previous release of Oracle ATG (11.1). At the time of this writing the latest release is 11.2. The scripts are coded to assume that the Oracle ATG assets have 11.1 in the name, so you can't just download 11.2 and have it work here. Sorry.
- Go to Oracle Edelivery
- Sign in
- Accept the restrictions
- On the search page, search for and select the following components:
- Oracle ATG Web Commerce
- Oracle Endeca Developer
- Select the platform "Linux x86-64"
- Click Continue
- Click "select alternate release" and select 11.1.0.0.0
- Click Continue
- Accept the terms and conditions
- You don't need to download everything. Download the following files:
- "Oracle Commerce Platform"
- "Oracle Commerce Reference Store"
- "Oracle Commerce MDEX Engine"
- "Oracle Commerce Content Acquisition System"
- "Oracle Commerce Experience Manager Tools and Frameworks"
- "Oracle Commerce Guided Search Platform Services"
NOTE The Experience Manager Tools and Frameworks zipfile (V46389-01.zip) expands to a cd directory containing an installer. It's not strictly required to unzip this file. If you don't unzip V46389-01.zip the provisioner will do it for you.
- Go to the Oracle JDK 7 Downloads Page
- Download "jdk-7u72-linux-x64.rpm"
- Go to the JBoss product downloads page
- Click "View older downloads"
- Click on the zip downloader for 6.1.0.GA
- Go to the Oracle 12c driver downloads page
- Download ojdbc7.jar
All oracle drivers are backwards compatible with the officially supported database versions at the time of the driver's release. You can use ojdbc7 to connect to either 12c or 11g databases.
IMPORTANT: Move everything you downloaded to the {ATG-CRS}/softwaredirectory at the top level of this project.
Before going any further, make sure your software directory looks like one of the following:
If you seclected Oracle 11g:
software/
├── OCPlatform11.1.bin
├── OCReferenceStore11.1.bin
├── OCcas11.1.0-Linux64.sh
├── OCmdex6.5.1-Linux64_829811.sh
├── OCplatformservices11.1.0-Linux64.bin
├── V46389-01.zip
├── jboss-eap-6.1.0.zip
├── jdk-7u72-linux-x64.rpm
├── ojdbc7.jar
├── p13390677_112040_Linux-x86-64_1of7.zip
├── p13390677_112040_Linux-x86-64_2of7.zip
└── readme.txt
if you selected Oracle 12c:
software/
├── OCPlatform11.1.bin
├── OCReferenceStore11.1.bin
├── OCcas11.1.0-Linux64.sh
├── OCmdex6.5.1-Linux64_829811.sh
├── OCplatformservices11.1.0-Linux64.bin
├── V46389-01.zip
├── jboss-eap-6.1.0.zip
├── jdk-7u72-linux-x64.rpm
├── linuxamd64_12102_database_1of2.zip
├── linuxamd64_12102_database_2of2.zip
├── ojdbc7.jar
└── readme.txt
Install the latest version of Vagrant. Install the latest 4.x release of VirtualBox. I've had issues installing the database using Virtualbox 5.x. Also get the vagrant-vbguest plugin. You install it by typing from the command line:
vagrant plugin install vagrant-vbguest
This project comes with two databases vm definitions. Pick either Oracle 11g or 12c. They both run on the same private IP address, so ATG will connect to either one the same way.
For 11g, type
vagrant up db11g
For 12c type
vagrant up db12c
This will set in motion an amazing series of events, and can take a long time, depending on your RAM, processor speed, and internet connection speed. The scripts will:
- download an empty centos machine
- switch it to Oracle Linux (an officially supported platform for Oracle 11g and ATG 11.1)
- install all prerequisites for the oracle database
- install and configure the oracle db software
- create an empty db name
orcl - import the CRS tables and data
To get a shell on the db vm, type
vagrant ssh db11g|db12c
You'll be logged in as the user "vagrant". This user has sudo privileges (meaning you can run somecommandas root by typing sudo somecommand). To su to root (get a root shell), type su -. The root password is "vagrant". If you want to su to the oracle user, the easiest thing to do is to su to root and then type su - oracle. The "oracle" user is the user that's running oracle and owns all the oracle directories. The project directory will be mounted at /vagrant. You can copy files back and forth between your host machine and the VM using that directory.
Key Information:
- The db vm has the private IP 192.168.70.4. This is defined at the top of the Vagrantfile.
- The system username password combo is system/oracle
- The ATG schema names are crs_core,crs_pub,crs_cata,crs_catb. Passwords are the same as schema name.
- The SID (database name) is orcl
- It's running on the default port 1521
- You can control the oracle server with a service: "sudo service dbora stop|start"
vagrant up atg
When it's done you'll have a vm created that is all ready to install and run ATG CRS. It will have installed jdk7 at /usr/java/jdk1.7.0_72 and jboss at /home/vagrant/jboss/. You'll also have the required environment variables set in the .bash_profile of the "vagrant" user.
To get a shell on the atg vm, type
vagrant ssh atg
Key Information:
- The atg vm has the private IP 192.168.70.5. This is defined at the top of the Vagrantfile.
- java is installed in
/usr/java/jdk1.7.0_72 - jboss is installed at
/home/vagrant/jboss - Your project directory is mounted at
/vagrant. You'll find the installers you downloaded at/vagrant/softwarefrom within the atg vm - All the endeca software is installed under
/usr/local/endecaand your CRS endeca project is installed under/usr/local/endeca/Apps
For your convenience, this project contains scripts that start the ATG servers with the correct options. Use vagrant ssh atgto get a shell on the atg vm, and then run:
/vagrant/scripts/atg/startPublishing.sh
and then in a different shell
/vagrant/scripts/atg/startProduction.sh
Both servers start in the foreground. To stop them either press control-c or close the window.
Key Information:
- The ATGProduction server's primary HTTP port is 8080. You access its dynamo admin at: http://192.168.70.5:8080/dyn/admin
- The ATGPublishing server's primary HTTP port is 8180. You access its dynamo admin at: http://192.168.70.5:8180/dyn/admin. It's started with the JBoss option
-Djboss.socket.binding.port-offset=100so every port is 100 more than the corresponding ATGProduction port. - The ATG admin username and password is: admin/Admin123. This applies to both ATGPublishing and ATGProduction. Use this to log into Dynamo Admin and the BCC
- The various endeca components are installed as the following services. From within the atg vm, you can use the scripts
/vagrant/scripts/atg/start_endeca_services.shand/vagrant/scripts/atg/stop_endeca_services.shto start|stop all the endeca services at once:- endecaplatform
- endecaworkbench
- endecacas
At this point, you can pick up the ATG CRS documentation from the Configuring and Running a Full Deployment section. Your publishing server has all the CRS data, but nothing has been deployed to production. You need to:
- Deploy the crs data
- Check the Endeca baseline index status
- Promote the CRS content from the command line
Do this from within the BCC by following the docs
Do this from within the Dynamo Admin by following the docs
Do this from the command line from within the atg vm:
vagrant ssh atg
/usr/local/endeca/Apps/CRS/control/promote_content.sh
The CRS application is live at: