Conventions

Images denote information that is specific to particular edition, business model, database management system, or operating system.

Enterprise Applicable only to WebSphere (R) Commerce Enterprise.
Professional Applicable only to WebSphere Commerce Professional.
Express Applicable only to WebSphere Commerce - Express.
Developer Applicable only to WebSphere Commerce Developer. WebSphere Commerce Developer is available in the same editions as WebSphere Commerce. Use the edition of WebSphere Commerce Developer that matches your edition of WebSphere Commerce. This documentation set refers to these products collectively as the WebSphere Commerce Developer.
Consumer direct Applicable when a consumer direct store is selected in WebSphere Commerce Accelerator.
B2B direct Applicable when a B2B direct store is selected in WebSphere Commerce Accelerator.
Derby Specific to the Apache Derby database.
DB2 Specific to the DB2 Universal Database (TM).
Oracle Specific to the Oracle database.
AIX Specific to programs that run on AIX (R).
System i5 Specific to programs that run on System i5 (TM).
System p5 Specific to programs that run on System p5 (TM).
System z9 Specific to programs that run on System z9 (TM).
Windows Vista Specific to programs that run on Windows Vista.
Linux Specific to programs that run on Linux.
Solaris Specific to programs that run on Solaris Operating System or Solaris Operating Environment.
Windows Specific to programs that run on Windows Server 2003 or Windows Server 2008.
Windows XP Specific to programs that run on Windows XP.
Windows 7 Specific to programs that run on Windows 7.
Portal Applicable only to WebSphere Portal.
Portal Version 6.1 Applicable only to WebSphere Portal, Version 6.1.
WebSphere Commerce version 5.6.1 Specific to WebSphere Commerce version 5.6.1.
Introduced in WebSphere Commerce Version 7 Feature Pack 1. Applies to all subsequent feature packs.
Introduced in WebSphere Commerce Version 7 Feature Pack 2. Applies to all subsequent feature packs.
Introduced in WebSphere Commerce Version 7 Feature Pack 3. Applies to all subsequent feature packs.
WebSphere Commerce Version 7 Feature Pack 4 Introduced in WebSphere Commerce Version 7 Feature Pack 4. Applies to all subsequent feature packs.
WebSphere Commerce Version 7 Feature Pack 5 Introduced in WebSphere Commerce Version 7 Feature Pack 5. Applies to all subsequent feature packs.
WebSphere Commerce Version 7 Feature Pack 6 Introduced in WebSphere Commerce Version 7 Feature Pack 6. Applies to all subsequent feature packs.
WebSphere Commerce Version 7 Feature Pack 7 Introduced in WebSphere Commerce Version 7 Feature Pack 7. Applies to all subsequent feature packs.
WebSphere Commerce Version 7 Feature Pack 8 Introduced in WebSphere Commerce Version 7 Feature Pack 8. Applies to all subsequent feature packs.
WebSphere Commerce Version 7 Feature Pack 1 Specific to WebSphere Commerce Version 7 Feature Pack 1.
WebSphere Commerce Version 7 Feature Pack 2 Specific to WebSphere Commerce Version 7 Feature Pack 2.
WebSphere Commerce Version 7 Feature Pack 3 Specific to WebSphere Commerce Version 7 Feature Pack 3.
WebSphere Commerce Version 7 Feature Pack 4 Specific to WebSphere Commerce Version 7 Feature Pack 4.
WebSphere Commerce Version 7 Feature Pack 5 Specific to WebSphere Commerce Version 7 Feature Pack 5.
WebSphere Commerce Version 7 Feature Pack 6 Specific to WebSphere Commerce Version 7 Feature Pack 6.
WebSphere Commerce Version 7 Feature Pack 7 Specific to WebSphere Commerce Version 7 Feature Pack 7.
WebSphere Commerce Version 7 Feature Pack 8 Specific to WebSphere Commerce Version 7 Feature Pack 8.
WebSphere Commerce Version 7.0.0.1 Introduced in WebSphere Commerce Version 7 7.0.0.1. Applies to all subsequent fix packs.
WebSphere Commerce Version 7.0.0.2 Introduced in WebSphere Commerce Version 7 7.0.0.2. Applies to all subsequent fix packs.
WebSphere Commerce Version 7.0.0.3 Introduced in WebSphere Commerce Version 7 7.0.0.3. Applies to all subsequent fix packs.
WebSphere Commerce Version 7.0.0.4 Introduced in WebSphere Commerce Version 7 7.0.0.4. Applies to all subsequent fix packs.
WebSphere Commerce Version 7.0.0.5 Introduced in WebSphere Commerce Version 7 7.0.0.5. Applies to all subsequent fix packs.
WebSphere Commerce Version 7.0.0.6 Introduced in WebSphere Commerce Version 7 7.0.0.6. Applies to all subsequent fix packs.
WebSphere Commerce Version 7.0.0.7 Introduced in WebSphere Commerce Version 7 7.0.0.7. Applies to all subsequent fix packs.
WebSphere Commerce Version 7.0.0.8 Introduced in WebSphere Commerce Version 7 7.0.0.8. Applies to all subsequent fix packs.
WebSphere Commerce Version 7.0.0.1 Specific to WebSphere Commerce Version 7.0.0.1.
WebSphere Commerce Version 7.0.0.2 Specific to WebSphere Commerce Version 7.0.0.2.
WebSphere Commerce Version 7.0.0.3 Specific to WebSphere Commerce Version 7.0.0.3.
WebSphere Commerce Version 7.0.0.4 Specific to WebSphere Commerce Version 7.0.0.4.
WebSphere Commerce Version 7.0.0.5 Specific to WebSphere Commerce Version 7.0.0.5.
WebSphere Commerce Version 7.0.0.6 Specific to WebSphere Commerce Version 7.0.0.6.
WebSphere Commerce Version 7.0.0.7 Specific to WebSphere Commerce Version 7.0.0.7.
WebSphere Commerce Version 7.0.0.8 Specific to WebSphere Commerce Version 7.0.0.8.
WebSphere Commerce Version 7.0.0.9 Specific to WebSphere Commerce Version 7.0.0.9.
Deprecated functionality

Variables

businessmodel
The name of the business model with which you are working (for example, consumer direct or B2B direct, extended sites, supply chain, or demand chain).
cell_name
The name of the WebSphere Application Server cell. Cells are arbitrary, logical groupings of one, or more nodes in a WebSphere Application Server distributed network that are managed together by a WebSphere Network Deployment Manager. In this definition, a node is a single occurrence of WebSphere Application Server and the applications that run inside the occurrence of WebSphere Application Server.
db_password
The password for the database user.
dba_password
The password for the database administrator. Use dba_password if table and database locks require administrator privileges. For example, if WebSphere Commerce is configured as an authoring server, or WebSphere Commerce Developer is configured to use an authoring server database.
db_schema
The database user ID (schema owner). This value is typically the same value as the value for db in development_db.
db_user
The database user.
development_db
Developer The name of your WebSphere Commerce development database.
drive
Windows The letter that represents the drive on which you installed the product or component that is being discussed (for example, C:).
host_name
The fully qualified host name of your WebSphere Commerce Server (for example, wcserver.mydomain.ibm.com is fully qualified).
instance_name
The name of the WebSphere Commerce instance with which you are working (for example, demo).
locale
A language and country-specific code. By default, WebSphere Commerce supports the following locales:
ar_EG
Arabic Egypt.
en_US
United States English.
fr_FR
French.
de_DE
German.
it_IT
Italian.
es_ES
Spanish.
pt_BR
Brazilian Portuguese.
zh_CN
Simplified Chinese.
zh_TW
Traditional Chinese.
ko_KR
Korean.
ja_JP
Japanese.
pl_PL
Polish.
ro_RO
Romanian.
ru_RU
Russian.
Management_Center_component
The name of the Management Center tool or area with which you want to work. The values are catalog, marketing, promotion, foundation, and shell.
node_name
The short (unqualified) host name of your WebSphere Commerce node (for example, wcserver). A WebSphere Commerce node is a node in your topology that contains the WebSphere Commerce Server.
profile_name
The name of the WebSphere Application Server profile that is created for your WebSphere Commerce instance.
storedir
The name of the directory in which store-specific assets are located, as defined in the DIRECTORY column of the STORE table.
storeId
The store entity ID as defined in the STORE_ID column of the STORE table.
target_db
The name of the database that is used by your target WebSphere Commerce Server.
WAS_instance_name
The name of the WebSphere Application Server with which your WebSphere Commerce instance is associated.
WC_enterprise_application
WC_instance_name. For example, given the instance_name demo, the value of WC_enterprise_application is WC_demo.
WCServer_enterprise_archive
WC_instance_name.ear. For example, given the instance_name demo, the value of WCServer_enterprise_archive is WC_demo.ear.
widgetdir
The name of the directory in which site-level widget storefront assets are included.
  • Feature Pack 7Widgets
  • Feature Pack 8Widgets_701

Path variables

Ant_installdir
The installation directory for Apache Ant.
DB2_installdir
This directory is the installation path for DB2 Universal Database. These directories are the default installation paths:
For DB2 Version 9.5:
  • AIXSolaris /opt/IBM/db2/V9.5
  • Linux /opt/ibm/db2/V9.5
  • Windows C:\Program Files\IBM\SQLLIB
WebSphere Commerce Version 7.0.0.3WebSphere Commerce Version 7.0.0.5WebSphere Commerce Version 7.0.0.2WebSphere Commerce Version 7.0.0.4WebSphere Commerce Version 7.0.0.1For DB2 Version 9.7:
  • AIXSolaris /opt/IBM/db2/V9.7
  • Linux /opt/ibm/db2/V9.7
  • Windows C:\Program Files\IBM\SQLLIB
WebSphere Commerce Version 7.0.0.7 or laterFor DB2 Version 10.1:
  • AIXSolaris /opt/IBM/db2/V10.1
  • Linux /opt/ibm/db2/V10.1
  • Windows C:\Program Files\IBM\SQLLIB
WebSphere Commerce Version 7.0.0.8 or laterFor DB2 Version 10.5:
  • AIXSolaris /opt/IBM/db2/V10.5
  • Linux /opt/ibm/db2/V10.5
  • Windows C:\Program Files\IBM\SQLLIB
HTTPServer_installdir
This directory is the installation directory for IBM HTTP Server. These directories are the defaults for IBM HTTP Server, version 7.0:
  • AIX /usr/IBMIHS/
  • Linux /opt/WebSphere/HTTPServer
  • Solaris /opt/IBMIHS
  • Windows C:\Program Files\IBM HTTP Server
LC_profiledir
This directory is the path for the WebSphere Application Server profile for Lotus Connections. A profile is the set of files that define the runtime environment. These directories are the default profile paths:
  • AIXLinux SolarisWindowsWAS_installdir/profiles/profile_name
Note: The Profiles and Blogs applications can be deployed to different WebSphere Application Servers as part of a Lotus Connections installation. Because of this possibility, LC_profiledir can also have different values for Profiles and Blogs.
MVCPortlet_installdir
This directory is the installation directory for the WebSphere Commerce portlets:
  • DeveloperWCDE_installdir/portal/MVCPortlet/MVCPortlet.war
  • WC_installdir/portal/MVCPortlet/MVCPortlet.war
Oracle_installdir
This directory is the installation path for the Oracle database.
RAD_installdir
This directory is the installation directory for Rational Application Developer. These directories are the default installation directories:
  • Linux /opt/IBM/Rational/SDP/7.0
  • Windows C:\Program Files\IBM\Rational\SDP\7.0
refapphome
This path is the installation path for reference application. The default installation path is WC_installdir/refapps/ref-app-name, where ref-app-name is the name of the reference application.
SC_installdir
Windows This directory is the installation path for Sales Center. The default installation path for Sales Center is:
  • C:\Program Files\IBM\WebSphere\SalesCenter70
Feature Pack 7 or laterSearch_eardir
Feature Pack 7 or laterThis directory is the path for the WebSphere Commerce search enterprise archive. For example, /opt/WebSphere/AppServer/profiles/demo_solr/installedApps/demo_search_cell/Search_demo.ear
Feature Pack 7 or laterThese directories are the default paths:
  • SolarisLinuxAIXFor IBM i OS operating systemWC_profiledir/installedApps/cell_name_search_cell/Search_instance_name.ear/
  • WindowsWC_profiledir\installedApps\cell_name_search_cell\Search_instance_name.ear\
  • Developer workspace_dir/Search/
Introduced in Feature Pack 2Search_home
Introduced in Feature Pack 2The location of the WebSphere Commerce search home directory path.
Introduced in Feature Pack 2The default value is the following path:
  • WebSphere Commerce DeveloperWCDE_installdir/search/
  • SolarisLinuxWindowsAIXWC_installdir/instances/instance_name/search/
  • For IBM i OS operating systemWC_instance_root/search/
Introduced in Feature Pack 2Solr_cell
Introduced in Feature Pack 2The root of the Solr Cell application. Solr uses Cell to index the content of documents.
Introduced in Feature Pack 2The default value is the following path:
  • SolarisLinuxAIX/opt/WebSphere/AppServer/profiles/solr/config/cells/solr_cell/
Introduced in Feature Pack 2solrhome
Introduced in Feature Pack 2The location of the Solr home directory path that contains the index data of Solr. The value must be an absolute path.
Introduced in Feature Pack 2The default value is the following path:
  • WebSphere Commerce DeveloperWCDE_installdir\search\solr\home
  • SolarisLinuxWindowsAIXWC_installdir/instances/instance_name/search/solr/home
  • For IBM i OS operating systemWC_instance_root/search/solr/home
StaticHTMLAssets_tempDir
This directory is the temporary directory where you extracted the Static HTML Assets package.
Introduced in Feature Pack 3Sterling_dir
Introduced in Feature Pack 3The directory where Sterling Selling and Fulfillment Suite is installed, for example /opt/Sterling.
Introduced in Feature Pack 3Sterling_eardir
Introduced in Feature Pack 3This directory is the path for the Sterling enterprise archive, for example: /opt/WebSphere/AppServer/profiles/sterlingApp/installedApps/cxvm20Node03Cell/Sterling Applications.ear
Store_archivedir
The directory path for the store web application archive (WAR) file of a WebSphere Commerce instance, for example: WC_eardir/Stores.war
TestAssets_tempDir
This directory is the temporary directory where you extracted the Test Assets package.
UPDI_tempdir
This directory is the temporary directory where you save the WebSphere Commerce Update Installer download package.
UPDI_installdir
This directory is the installation directory of the WebSphere Commerce Update Installer. This installer is used to install fix packs and APARs.
  • AIX /usr/IBM/WebSphere/UpdateInstaller
  • For IBM i OS operating system/QIBM/ProdData/WebSphere/UpdateInstaller
  • Linux/opt/WebSphere/wc-updateinstaller
  • Solaris /opt/WebSphere/wc-updateinstaller
  • Windows C:\Program Files\IBM\WebSphere\UpdateInstaller
  • WebSphere Commerce DeveloperWCDE_installdir\UpdateInstaller
WAS_installdir
This directory is the installation path for WebSphere Application Server. These directories are the default installation paths:
  • AIX /usr/IBM/WebSphere/AppServer
  • For IBM i OS operating system/QIBM/ProdData/WebSphere/AppServer/V7/edition, where edition is either ND or BASE
  • Linux/opt/IBM/WebSphere/AppServer
  • Solaris /opt/IBM/WebSphere/AppServer
  • Windows C:\Program Files\IBM\WebSphere\AppServer
WAS_userdir
For IBM i OS operating system This directory is the path for all the data that is used by WebSphere Application Server that can be modified or must be configured by the user. The default path is /QIBM/UserData/WebSphere/AppServer/V7/edition, where edition is either ND or BASE.
WCBD_installdir
The installation directory for the WebSphere Commerce Build and Deployment tool. These directories are the default installation paths:
  • WC_installdir\wcbd
  • WebSphere Commerce DeveloperWCDE_installdir\wcbd
WCBD_deploy_server_common_dir
The common directory to store the server deployment package installations.
WCBD_deploy_server_dir
The installation directory for the server deployment package that is created by the build process.
WCBD_deploy_toolkit_common_dir
The common directory to store the development environment deployment package installations.
WCBD_deploy_toolkit_dir
The installation directory for the development environment deployment package that is created by the build process.
WC_eardir
This directory is the path for the WebSphere Commerce Enterprise Archive. These directories are the default paths:
  • SolarisLinuxAIXFor IBM i OS operating systemWC_profiledir/installedApps/cell_name/instance_name.ear/
  • WindowsWC_profiledir\installedApps\cell_name\instance_name.ear\
  • Developer workspace_dir/WC/
Note: XML files in WC_eardir/xml are not updated directly. For more information about working with the files in this directory, see XML configuration directory.
WC_installdir
This directory is the installation path for WebSphere Commerce. These directories are the default installation paths for WebSphere Commerce:
  • AIX /usr/IBM/WebSphere/CommerceServer70
  • For IBM i OS operating system/QIBM/ProdData/CommerceServer70
  • SolarisLinux /opt/IBM/WebSphere/CommerceServer70
  • WindowsC:\Program Files\IBM\WebSphere\CommerceServer70
WC_instance_root
For IBM i OS operating systemThe default path is /QIBM/UserData/CommerceServer70/instances/instance_name.
WC_profiledir
This directory is the path for the WebSphere Application Server profile for WebSphere Commerce. A profile is the set of files that define the runtime environment. These directories are the default profile paths:
  • SolarisLinuxAIXWAS_installdir/profiles/profile_name
  • For IBM i OS operating systemWAS_userdir/profiles/profile_name
  • WindowsWAS_installdir\profiles\profile_name
WC_userdir
For IBM i OS operating systemThis directory is the directory for all the data that is used by WebSphere Commerce that can be modified or must be configured by the user. The default path is /QIBM/UserData/CommerceServer70.
WCDE_installdir
This directory is the installation directory for the WebSphere Commerce development environment. The default installation directory depends on your edition of WebSphere Commerce Developer:
  • Express C:\WCToolkitExpress70
  • Professional C:\WCToolkitPro70
  • Enterprise C:\WCToolkitEE70
WP_installdir
This directory is the installation directory for WebSphere Portal:
  • AIX /usr/IBM/WebSphere/PortalServer
  • For IBM i OS operating system/QIBM/ProdData/PortalServer/V7
  • SolarisLinux /opt/IBM/WebSphere/PortalServer
  • WindowsC:\Program Files\IBM\WebSphere\PortalServer
workspace_dir
Developer This directory is the WebSphere Commerce workspace directory. The default is WCDE_installdir\workspace.