WebSphere® Application Server environment variables

Unless you change the directory paths during the installation, the default IBM® WebSphere® environment variables are defined for HCL Connections application directories. These variables are referenced from the configuration files that are associated with the applications.

Default environment variables

The following tables list the default environment variables that are defined for application directories and for the customization base directory.
Note: Production deployments often use more than one shared content store to avoid problems when applications attempt to read or write to a device at the same time. If you use multiple devices, change the environment variables to match your deployment. You must also update the properties in the HCL Connections configuration engine; otherwise, the export/import utility does not work properly.

Also, do not use network paths when you define content store locations.

For more information about IBM® Connections configuration engine properties, see ConfigEngine properties.
Table 1. Activities default WebSphere® environment variables
Variable name Description / Local or shared* Default value
ACTIVITIES_STATS_DIR Statistics directory / shared

AIX® and Linux: /opt/IBM/Connections/data/shared/activities/statistic

Microsoft Windows: C:\Program Files\IBM\Connections\data\shared\activities\statistic

Table 2. Bookmarks default WebSphere® environment variables
Variable name Description / Local or shared* Default value
DOGEAR_FAVICON_DIR Icons upload directory / shared

AIX® and Linux: /opt/IBM/Connections/data/shared/dogear/favorite

Microsoft Windows: C:\Program Files\IBM\Connections\data\shared\dogear\favorite

Table 3. Communities default WebSphere® environment variables
Variable name Description / Local or shared* Default value
CATALOG_INDEX_DIR Directory in which the index is stored / local

AIX® and Linux: /opt/IBM/Connections/data/local/catalog/index

Microsoft Windows: C\Program Files\IBM\Connections\data\local\catalog\index

CATALOG_REPLICATION_DIR Directory in which the delta index files are stored / shared

AIX® and Linux: /opt/IBM/Connections/data/shared/catalog/indexReplication

Microsoft Windows: C\Program Files\IBM\Connections\data\shared\catalog\indexReplication

Table 4. Customization default WebSphere® environment variable
Variable name Description / Local or shared* Default value
CONNECTIONS_CONFIGURATION_PATH Stores configuration information and policies for IBM® Connections applications and users.

AIX® and Linux: /opt/IBM/Connections/data/shared/configuration

Microsoft Windows: C:\IBM\Connections\data\shared\configuration

CONNECTIONS_ CUSTOMIZATION_PATH

Customization directory / shared

AIX® and Linux: /opt/IBM/Connections/data/shared/customization

Microsoft Windows: C:\Program files\IBM\Connections\data\shared\customization

Table 5. News default WebSphere® environment variables
Variable name Description / Local or shared* Default value

ACTIVITY_STREAM_SEARCH_INDEX_DIR

Directory in which the index for Activity Stream search is stored / local

AIX® and Linux: /opt/IBM/Connections/data/local/news/search/index

Microsoft Windows: C:\Program Files\IBM\Connections\data\local\news\search\index

ACTIVITY_STREAM_SEARCH_REPLICATION_DIR

Replication directory for Activity Stream Search / shared

AIX® and Linux: /opt/IBM/Connections/data/shared/news/search/indexReplication

Microsoft Windows: C:\Program Files\IBM\Connections\data\shared\news\search\indexReplication

AUDIT_FILE_ROOT_DIR Stores temporary attachments for audit purposes. / shared Not set by default.
Table 6. Profiles default WebSphere® environment variables
Variable name Description / Local or shared* Default value
PROFILES_CACHE_DIR Cache directory / local

AIX® and Linux: /opt/IBM/Connections/data/shared/profiles/cache

Microsoft Windows: C:\Program Files\IBM\Connections\data\shared\profiles\cache

PROFILES_STATS_DIR Statistics directory / shared

AIX® and Linux: /opt/IBM/Connections/data/shared/profiles/statistic

Microsoft Windows: C:\Program Files\IBM\Connections\data\shared\profiles\statistic

Table 7. Search default WebSphere® environment variables
Variable name Description / Local or shared* Default value

CRAWLER_PAGE_PERSISTENCE_DIR

Directory that is used to store the seedlist pages persisted during crawling.

AIX® and Linux: /opt/IBM/Connections/data/local/search/persistence

Microsoft Windows: C:\Program Files\IBM\Connections\data\local\search\persistence

EXTRACTED_FILE_STORE Directory that is used to store the extracted file content.

AIX® and Linux: /opt/IBM/Connections/data/shared/search/extracted

Microsoft Windows: C:\Program Files\IBM\Connections\data\shared\search\extracted

SEARCH_DICTIONARY_DIR

Dictionary directory / shared

AIX® and Linux: /opt/IBM/Connections/data/shared/search/dictionary

Microsoft Windows: C:\Program Files\IBM\Connections\data\shared\search\dictionary

SEARCH_INDEX_DIR Index directory / local

AIX® and Linux: /opt/IBM/Connections/data/local/search/index

Microsoft Windows: C:\Program Files\IBM\Connections\data\local\search\index

SEARCH_INDEX_BACKUP_DIR Backup index directory / local

AIX® and Linux: /opt/IBM/Connections/data/local/search/index_backup

Microsoft Windows: C:\Program Files\IBM\Connections\data\local\search\index_backup

SEARCH_INDEX_SHARED_COPY_LOCATION

Directory that is used for automatic distribution of the baseline index to other nodes. An index in this folder will be deleted 30 days after it is created. If this variable is deleted, automatic index rollout is disabled. / shared

AIX® and Linux: /opt/IBM/Connections/data/shared/search/staging/

Microsoft Windows: C:\Program Files\IBM\Connections\data\shared\search\staging\

Table 8. WebSphere® Application Server Service Integration Bus file store environment variables
Variable name Description / Local or shared* Default value
MESSAGE_STORE_PATH Directory that is used to store the files that are used and managed by the messaging engines of the WebSphere® Service Integration Bus (SIB) for the HCL Connections bus (permanent, temporary, and log file) / shared
Note: The same requirements for other shared content apply to this directory. In addition, if NFS is used, use version 4 of the protocol.

AIX® and Linux: /opt/IBM/Connections/data/shared

Microsoft Windows: C:\Program Files\IBM\Connections\data\shared

Shared content must be accessible (read/write) by all nodes in a cluster. The shared content store must be in a shared repository that grants read/write access to the Deployment Manager and all the nodes. Use one of the following methods to create a shared data directory:
  • Network-based file shares (for example: NFS, SMB/Samba, and other share types)
  • Storage area network drives (SAN)
  • If you are using a shared-file system on Microsoft Windows, specify the file location by using the Universal Naming Convention (UNC) format. For example: \\server_name\share_name
Note: From version 3 of HCL Connections, all variables changed from being server-level variables to cell-level variables. Variables with a server level scope are more granular than variables with a node or cell level scope.

Both shared and local content stores must be accessible by using the same path from nodes and the deployment manager.