Conventions

Images denote information that is specific to particular edition, business model, database management system, or operating system.
Enterprise Applicable only to HCL Commerce Enterprise.
Professional Applicable only to HCL Commerce Professional.
Developer Applicable only to HCL Commerce Developer. HCL Commerce Developer is available in the same editions as HCL Commerce. Use the edition of HCL Commerce Developer that matches your edition of HCL Commerce. The IBM Knowledge Center refers to these products collectively as the HCL Commerce Developer.
B2C Applicable to a B2C store.
B2B Applicable to a B2B store.
Oracle Specific to the Oracle database.
DB2 Specific to the DB2 Universal Database (TM).
Linux Specific to programs that run on Linux.

Variables

businessmodel
The name of the business model with which you 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 HCL Commerce is configured as an authoring environment, or HCL 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 your HCL 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 your HCL Commerce server (for example, wcserver.mydomain.ibm.com is fully qualified).
instance_name
The name of the HCL Commerce instance with which you are working (for example, demo).
locale
A language and country-specific code. By default, HCL 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 you 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 that is used by your target Transaction server.
WAS_instance_name
The name of the WebSphere Application Server with which your HCL 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).
  • HCL Commerce EAR in the Transaction server Docker container: /opt/WebSphere/AppServer/profiles/default/installedApps/localhost/ts.ear
  • HCL 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
This directory is the path to where the certificates are stored.
  • In the Transaction Server Docker container: /profile/config/cells/localhost/nodes/localhost.
    Note: To add your 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.
  • HCL Commerce DeveloperLiberty_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_installdir
This directory is the installation path for IBM Db2 Advanced Workgroup Server Edition Version 11.1 database. For example,
  • Linux/opt/ibm/db2/V11.1
  • LinuxC:/IBM/SQLLIB
deployment_scripts
This directory contains the scripts that determine how your 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 your custom scripts that you want 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
HCL Commerce DeveloperIn the Search server : /opt/WebSphere/Liberty/usr/servers/searchServer/configDropins/overrides/jndi.xml
HCL Commerce DeveloperIn 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
HCL Commerce DeveloperIn the Search server: /opt/WebSphere/Liberty/usr/servers/searchServer/jvm.options
HCL Commerce DeveloperIn the Store server: /opt/WebSphere/Liberty/usr/servers/crsServer/jvm.options
HCL Commerce DeveloperIn 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:
  • LinuxWebSphere Application Server Liberty running in containers: /opt/WebSphere/Liberty
  • HCL Commerce DeveloperWebSphere Application Server Liberty in HCL 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
HCL Commerce DeveloperWebSphere Application Server: WCDE_installdir/wasprofile/logs/server1
HCL Commerce DeveloperWebSphere Liberty: C:/WebSphere/Liberty/user/servers/serverName/logs
OracleOracle_installdir
OracleThis 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 that you can use to configure your Docker containers.
  • /SETUP/lib
Search_eardir
This directory is the path for the HCL 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 that contains the index data of Solr. The value must be an absolute path.
The default value 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,
  • LinuxWebSphere Application Server running in containers: /opt/WebSphere/AppServer
  • HCL Commerce DeveloperWebSphere Application Server in HCL Commerce Developer environment: C:/WebSphere/AppServer
WC_eardir
This directory is the path for the HCL Commerce Enterprise Archive:
  • LinuxIn the Transaction Docker container: /opt/WebSphere/AppServer/profiles/default/installedApps/localhost/ts.ear/
  • HCL Commerce Developerworkspace_dir/WC/
WC_profiledir
This directory is the path for the WebSphere Application Server profile for HCL Commerce. A profile is the set of files that define the runtime environment. These directories are the default profile paths:
  • AIXLinuxWAS_installdir/profiles/default
WCB_installdir
The installation directory for the HCL Commerce Build utility.
  • HCL Commerce DeveloperWCDE_installdir/wcbd
  • LinuxIn the Utility server Docker container: /opt/WebSphere/CommerceServer90/bin
HCL Commerce DeveloperWCDE_installdir
HCL Commerce DeveloperThis directory is the installation directory for the HCL Commerce Developer environment. The default installation directory is C:/IBM/WCDE90.
HCL Commerce Developerworkspace_dir
HCL Commerce Developer This directory is the HCL Commerce workspace directory. The default is WCDE_installdir/workspace.