WebSphere Commerce Developer

IBM WebSphere Commerce Developer

You might find the following information and links useful when you use WebSphere Commerce Developer Version 8.0 to customize WebSphere Commerce.

WebSphere Commerce Developer uses IBM Rational Application Developer for WebSphere Software for rapid development of JSP files, web content, commands, and EJB beans.

Start WebSphere Commerce Developer

  • From the command line:
    • Go to WCDE_installdir\bin.
    • Run the startWCToolkit.bat command. IBM Rational Application Developer for WebSphere Software opens and displays the WebSphere Commerce Developer workspace.
  • Browse the Start menu to manually start IBM Rational Application Developer for WebSphere Software and display the WebSphere Commerce Developer workspace.

Starting the test server

  1. Shut down any applications that use ports 80, 443, 8000, 8002, 8004, 8006, and 8007. These ports are required by the test server.
  2. In the Servers view, right-click WebSphere Commerce Test Server and choose Start. Depending on your computer specifications, the server can start within 5 minutes. Initialization is complete when you see text in the console that is similar to the following message: ADMU3000I: Server server1 open for e-business
If you want to debug, choose Debug instead of Start.

Workspace layout

The workspace contains the following projects:
CommerceAccelerator
Customize WebSphere Commerce Accelerator by creating and modifying assets in this web module.
LOBTools
Customize the IBM Management Center for WebSphere Commerce by creating and modifying assets in this web module.
OrganizationAdministration
Customize the Organization Administration console by creating and modifying assets in this web module.
Rest
Customize REST services by creating or modifying assets in this module.
Search
The enterprise archive (EAR) for the WebSphere Commerce search application.
Search-Rest
Customize WebSphere Commerce search-based REST services by creating or modifying assets in this module.
SiteAdministration
Customize the Site Administration console by creating and modifying assets in this web module.
Stores
Customize stores by creating and modifying assets in this web module.
WC
The enterprise archive (EAR) for the WebSphere Commerce application.
WebServicesRouter
Create custom web services in this web project.
WebSphereCommerceServerExtensionsData
Create custom enterprise beans in this module. Initially, this EJB module contains a simple stateless session bean.
WebSphereCommerceServerExtensionsLogic
Create custom Java classes in this project. Initially, this Java project is empty.

Useful URLs

After installation, the following URLs are available for you to use to test or demonstrate WebSphere Commerce functionality.
Note: The WebSphere Commerce Developer test server must be started before you can access and use any of the following tools or stores.
Business user tools

The default site administrator user ID for each tool is wcsadmin. The initial password is wcsadmin. When you initially log on to a tool, change the password for security reasons.

Starter stores

The default site administrator user ID to log on to a store is wcsadmin. The initial password is wcsadmin. When you initially log on to a store, change the password for security reasons.

Tools
  • Swagger UI

    A live version of the WebSphere Commerce REST API. It is composed of a set of static HTML, CSS, and JavaScript that dynamically documents the available REST API on the WebSphere Commerce test server by using the Swagger UI.

    Note: The Swagger UI is provided to you as-is. It contains the WebSphere Commerce REST API and other information that is related to the Swagger backend. Customizing the Swagger UI, for example, to display custom resource handlers, annotations, or extra data is not supported.
  • Query Template File Syntax Validator

    A JSP file for validating query template file syntax. Query template files define queries in the Data Service Layer. The template file maps queries on the logical model (XPath queries) to templated SQL statements. These templates are used to generate the SQL queries that are called by the Data Service Layer to access the database. The validator JSP file is accessible in only Internet Explorer on a local instance of WebSphere Commerce Developer. This JSP file cannot be used for remote access and testing.

Accessing and updating the WebSphere Commerce database

The Apache Derby database that is provided by default is in the WCDE_installdir/db directory. The database name for this database is mall. To connect to this database, use one of the following procedures:
  • WebSphere Commerce Test Server is running:

    Use the database access JSP to run SQL statements against the database. This JSP file is accessible only on a local instance of WebSphere Commerce Developer. This JSP file cannot be used for remote access and testing.

  • WebSphere Commerce Test Server is not running:
    1. In a command line utility, go to the WCDE_installdir\bin directory.
    2. Run the script ij.bat. An interactive session starts.
    3. Enter the following command: connect '..\db\mall'; End all of your SQL statements with a semicolon.
    4. You can also use ij.bat to run an SQL script by entering ij scriptName. Ensure that the scriptName is either a fully qualified file name or is a relative path from the WCDE_installdir\bin directory.
You can use the Data Load utility to load data into the database.

Logging

To control WebSphere Commerce logging settings, use the WebSphere Application Server administrative console.
  1. Right-click WebSphere Commerce Test Server. Select Administration Run administrative console.
  2. Access the logging configuration by selecting Troubleshooting. Then, select Logs and Trace.
  3. Select server1 as your server and select Change Log Detail Levels.
  4. Choose an option:
    Configuration
    The changes that you make are stored on the file system and are applied during server starts. A server restart is required to pick up any changes.
    Runtime
    The changes that you make are applied immediately. The changes are not saved when the server restarts.
  5. Expand com.ibm.websphere.commerce.* to view the components in WebSphere Commerce that can be logged. Click the component that you are interested in and select the logging level that you want to set for that component.
  6. When you finish your changes, click OK to store your changes.

Removing published starter stores

When you initially install WebSphere Commerce Developer, the Aurora extended sites starter store is published. If you decide that you do not want the starter store, use the WCDE_installdir\bin\resetdb.bat command to restore the database to the bootstrap configuration. Use the WCDE_installdir\bin\resetstores.bat command to reset the Stores web module back to its bootstrap state. Ensure that you create a backup before you run these scripts. The resetdb.bat script applies only to the Apache Derby database. If you want to publish a store, use the administration console.

Changing the database type

By default, WebSphere Commerce Developer is configured to use Apache Derby as the development environment database. If you want to use a different database, you must install your preferred database and change the database type from Apache Derby to your preferred database. Use the WCDE_installdir\bin\setdbtype.bat script to change the database type. This script configures your environment to use an existing database and optionally create a new bootstrap database. Running the setdbtype.bat script with no arguments displays the usage.

Ensure that IBM Rational Application Developer for WebSphere Software is not active when you run the setdbtype.bat script. If IBM Rational Application Developer for WebSphere Software is active, rerun the setdbtype.bat script after you stop IBM Rational Application Developer for WebSphere Software.

When you are creating a bootstrap database, run the WCDE_installdir\bin\resetstores.bat command to reset the Stores web module back to the bootstrap state.

Restoring WebSphere Commerce Developer to the default setup

Run the WCDE_installdir\bin\restoreDefault.bat script to restore the WebSphere Commerce Developer to the default configuration. The restoration is done at the maintenance level of the installation and not at the base level.

Trademarks and Service Marks

IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.