Conventions

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

	Applicable only to WebSphere (R) Commerce Enterprise.
	Applicable only to WebSphere Commerce Professional.
	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. The IBM Knowledge Center refers to these products collectively as the WebSphere Commerce Developer.
	Applicable to a B2C store.
	Applicable to a B2B store.
	Specific to the Oracle database.
	Specific to the DB2 Universal Database (TM).
	Specific to programs that run on Linux.

Variables

businessmodel

The name of the business model with which we are working (for example, B2C or B2B, extended sites).

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 environment, 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

The name of the WebSphere Commerce development database.

drive

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 the WebSphere Commerce server (for example, wcserver.mydomain.ibm.com is fully qualified).

instance_name

The name of the WebSphere Commerce instance with which we are working (for example, demo).

locale

A language and country-specific code. By default, WebSphere Commerce supports the following locales:

de_DE

German.

en_US

United States English.

es_ES

Spanish.

fr_FR

French.

it_IT

Italian.

ja_JP

Japanese.

ko_KR

Korean.

pl_PL

Polish.

pt_BR

Brazilian Portuguese.

ru_RU

Russian.

ro_RO

Romanian.

zh_CN

Simplified Chinese.

zh_TW

Traditional Chinese.

Management_Center_component

The name of the Management Center tool or area with which we want to work. The values are catalog, marketing, promotion, foundation, and shell.

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 used by your target Transaction Server.

WAS_instance_name

The name of the WebSphere Application Server with which the WebSphere Commerce instance is associated.

widgetdir

The name of the directory in which site-level widget storefront assets are included, Widgets

Path variables

Ant_installdir

The installation directory for Apache Ant.

application_dir

The directory to the runtime Enterprise Archive (EAR).

• WebSphere Commerce EAR in the Transaction server Docker container: /opt/WebSphere/AppServer/profiles/default/installedApps/localhost/ts.ear

• WebSphere Commerce Utility server Docker container EAR in the : /opt/WebSphere/AppServer/profiles/default/installedApps/localhost/ts.ear

• Customization EAR in the Customization server Docker container: /opt/WebSphere/Liberty/usr/servers/default/apps/commerceue-ear.ear

• Search EAR in the Search server Docker container: /opt/WebSphere/Liberty/usr/servers/default/apps/search-ear.ear

• Store EAR in the Store server Docker container: /opt/WebSphere/Liberty/usr/servers/default/apps/crs.ear

certificate_dir

Path to where the certificates are stored.

• In the Transaction Server Docker container: /profile/config/cells/localhost/nodes/localhost.

  Note: To add our own certificates into a new Docker image, use a Dockerfile to create a new image. In the Dockerfile, use the COPY instruction to copy the custom certificates to the /SETUP/certs/custom directory.

• In the Search, Store, and Customization server Docker containers: /opt/WebSphere/Liberty/usr/servers/default/resources/security.

• (Developer) Liberty_installdir/usr/servers/serverName/resources/security

data_source

This file determines the connection credentials from to the database.

• In the Search server Docker container: /opt/WebSphere/Liberty/usr/servers/default/configDropins/overrides/datasources.xml

• In the Transaction server Docker container: /opt/WebSphere/AppServer/profiles/default/config/cells/localhost/nodes/localhost/servers/server1/resources.xml

(DB2) DB2_installdir

(DB2) This directory is the installation path for IBM Db2 Advanced Workgroup Server Edition Version 11.1 database. For example,

• /opt/ibm/db2/V11.1

• C:/IBM/SQLLIB

deployment_scripts

This directory contains the scripts that determine how the containers start and which configurations and environment variables to use. Deployment scripts include entrypoint.sh, configure.sh, postConfiguration.sh, updateCerts.sh, applyCustomization.sh and any of our custom scripts to add.

• /SETUP/bin

HTTPServer_installdir

This directory is the installation directory for IBM HTTP Server in the Web server Docker container.

• /opt/WebSphere/HTTPServer

JNDI

The path to the jndi.xml file.

In the Search and Store server Docker containers: /opt/WebSphere/Liberty/usr/servers/default/configDropins/overrides/jndi.xml

(Developer) In the Search server : /opt/WebSphere/Liberty/usr/servers/searchServer/configDropins/overrides/jndi.xml

(Developer) In the Store server: /opt/WebSphere/Liberty/usr/servers/crsServer/configDropins/overrides/jndi.xml

JVM

The file to the jvm.options file that determines the JVM arguments to use.

In the Search, Store, and Customization server Docker containers: /opt/WebSphere/Liberty/usr/servers/default/jvm.options

In the Transaction server Docker container: /opt/WebSphere/AppServer/profiles/default/config/cells/localhost/nodes/localhost/servers/server1/server.xml

(Developer) In the Search server: /opt/WebSphere/Liberty/usr/servers/searchServer/jvm.options

(Developer) In the Store server: /opt/WebSphere/Liberty/usr/servers/crsServer/jvm.options

(Developer) In the Customization server: /opt/WebSphere/Liberty/usr/servers/commerceueServer/jvm.options

Liberty_installdir

This directory is the installation path for WebSphere Application Server Liberty. These directories are the default installation paths:

• (Linux) WebSphere Application Server Liberty running in containers: /opt/WebSphere/Liberty

• (Developer) WebSphere Application Server Liberty in WebSphere Commerce Developer environment: C:/WebSphere/Liberty

log_dir

On DC/OS:

• WebSphere Application Server: /mnt/mesos

• WebSphere Liberty: /mnt/mesos

On Non-DC/OS:

• WebSphere Application Server: /opt/WebSphere/AppServer/profiles/default/logs/server1

  • WebSphere Liberty: /opt/WebSphere/Liberty/usr/servers/default/logs

(Developer) WebSphere Application Server: WCDE_installdir/wasprofile/logs/server1

(Developer) WebSphere Liberty: C:/WebSphere/Liberty/user/servers/serverName/logs

(Oracle) Oracle_installdir

(Oracle) This directory is the installation path for the Oracle database. For example, /opt/oracle/app/oracle/product/12.1.0.

RAD_installdir

This directory is the installation directory for Rational Application Developer. For example, C:/IBM/Rational/SDP

RunEngine_classpath

This directory exists in the Docker containers. The directory holds the classes that define the Run Engine commands we use to configure our Docker containers.

• /SETUP/lib

Search_eardir

Path for the WebSphere Commerce search enterprise archive. For example, /opt/WebSphere/Liberty/usr/servers/default/apps/search-ear.ear. The Search_eardir is in the Search Docker container.

Search_ServerDir

The location of the Search server home directory. A subdirectory of Liberty/usr/servers with a composite name consisting of the prefix searchServer_ followed by a number that is installation-specific. For instance, searchServer_20160617180614.

search index

/opt/WebSphere/Liberty/usr/servers/default/resources/search

solrhome

The location of the Solr home directory path containing the index data of Solr. The value must be an absolute path.

Default is the following path:

• /opt/WebSphere/Liberty/usr/servers/default/resources/search/index/managed-solr/config

utilities_root

This directory is the base path for utilities and related files that are run in the Utility server Docker container: /opt/WebSphere/CommerceServer90.

WAS_installdir

This directory is the installation path for WebSphere Application Server. For example,

• (Linux) WebSphere Application Server running in containers: /opt/WebSphere/AppServer

• (Developer) WebSphere Application Server in WebSphere Commerce Developer environment: C:/WebSphere/AppServer

WC_eardir

Path for the WebSphere Commerce Enterprise Archive:

• (Linux) In the Transaction Docker container: /opt/WebSphere/AppServer/profiles/default/installedApps/localhost/ts.ear/

• (Developer) workspace_dir/WC/

WC_profiledir

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:

• (AIX) (Linux) WAS_installdir/profiles/default

WCB_installdir

The installation directory for the WebSphere Commerce Build utility.

• (Developer) WCDE_installdir/wcbd

• (Linux) In the Utility server Docker container: /opt/WebSphere/CommerceServer90/bin

(Developer) WCDE_installdir

(Developer) This directory is the installation directory for the WebSphere Commerce Developer environment. The default installation directory is C:/IBM/WCDE90.

(Developer) workspace_dir

(Developer) This directory is the WebSphere Commerce workspace directory. The default is WCDE_installdir/workspace.