Announcement: You can find the guides for Commerce 7.5 and later on the new Elastic Path Documentation site. This Developer Center contains the guides for Commerce 6.13.0 through 7.4.1.Visit new site

This version of Elastic Path Commerce is no longer supported or maintained. To upgrade to the latest version, contact your Elastic Path representative.

Running Elastic Path Applications

Running Elastic Path Applications

Elastic Path has two webapps: Cortex, Elastic Path's Hypermedia API, and Commerce Manager, a user interface for managing stores and inventory. These webapps are the part of Elastic Path Commerce that most business users see and interact with.

In development, the webapps and servers are used to test the business logic of Elastic Path Commerce and any extensions you have added.

All webapps and application servers are run from the extensions module and thus require all other Elastic Path source code to be built prior to starting them.

Elastic Path Webapps

The Cortex and Commerce Manager webapps depend on the Elastic Path application servers to start up and access all functionality. However, they can be started with a minimum set of servers if all functionality is not required by the developer.

Cortex

Starting Cortex and its dependencies is all that is required to test most development tasks. By default, Cortex starts on port 9080.

Prerequisites

The following application servers must be started:

  • JMS Server
  • Search Server

The following application servers are optional but recommended:

  • Integration Server: enables sending emails and Camel messages.

If this is the first time Cortex has been started on a particular machine, you must do the following:

  1. In the command line, navigate to the extensions/database module.
  2. In the extensions/database module, run the following command: 
    mvn clean install -Preset-conf

This command wipes your current local home directory's configuration files (if they exist), copies out of the box Cortex and Ehcache configuration files from the database/ext-data/environments/local/ directory to your file system's ${user.home}/ep/conf/ directory. For more information, see Cortex Configuration Files.

Running Cortex

  1. In the command line, navigate to the extensions/cortex/ext-cortex-webapp module.
  2. In the extensions/cortex/ext-cortex-webapp module, run the following command: 
    mvn clean tomcat7:run-war

Once started, you can access Cortex Studio at: http://localhost:9080/studio/ .

Commerce Manager

By default, Commerce Manager starts on port 8081.

Prerequisites

Commerce Manager can start without any supporting application servers.

The following application servers are optional but recommended:

  • Search Server

Running Commerce Manager

  1. In the command line, navigate to the extensions/cm/ext-cm-webapp-runner module.
  2. In the extensions/cm/ext-cm-webapp-runner module, run the following command:
    mvn clean tomcat7:run-war

Once started, you can sign into Commerce Manager at: http://localhost:8081/cm/.

The default user name and password are as follows:

User ID admin

Password

111111

Elastic Path Application Servers

Elastic Path webapps require the following application servers to be started before they are launched. As a general rule for development, only start the application servers needed for the functionality you are testing.

Batch Server

The Batch Sever is used for scheduled Quartz jobs. In general, this is only needed in production environments. For more information, see Elastic Path Quartz Jobs. By default, the Batch Server starts on port 8084.

To run the Batch Server:

  1. In the command line, navigate to the extensions/batch/ext-batch-webapp module.
  2. Run the following command: 
    mvn clean tomcat7:run-war

Once started, you can check the status of the Batch Server at http://localhost:8084/batch/status.

Integration Server

The Integration Server is used for any functionality that needs email delivery or messaging on Apache Camel routes. For more information, see Integration Server. By default, the Integration Server starts on port 8083.

To run the Integration Server:

  1. In the command line, navigate to the extensions/integration/ext-integration-webapp module.
  2. Run the following command: 
    mvn clean tomcat7:run-war

Once started, you can check the status of the Integration Server at http://localhost:8083/integration/status.

JMS Server

The JMS Server is used when making purchases.

To run the JMS Server:

  1. In the command line, navigate to the extensions/activemq-broker module.
  2. Run the following command: 
    mvn clean tomcat7:run-war

Once started, you can access the JMS Server at http://localhost:8161/admin.

Search Server

The Search Server is used for all search-related functionality. For more information, see Search Server. By default, the Search Server starts on port 8082.

To run the Search Server:

  1. In the command line, navigate to the extensions/search/ext-search-webapp module.
  2. Run the following command: 
    mvn clean tomcat7:run-war
Once started, you can check the status of the Search Server at http://localhost:8082/search/status.