Directory conventions

The following directory conventions are used throughout the documentation to must reference special directories such as wxs_install_root and wxs_home. You access these directories during several different scenarios, including during installation and use of command-line tools.

wxs_install_root
The wxs_install_root directory is the root directory where WebSphere® eXtreme Scale product files are installed. The wxs_install_root directory can be the directory in which the trial archive is extracted or the directory in which the WebSphere eXtreme Scale product is installed.
  • Example when extracting the trial:

    Example: /opt/IBM/WebSphere/eXtremeScale

  • Example when WebSphere eXtreme Scale is installed to a stand-alone directory:

    [Unix] Example: /opt/IBM/eXtremeScale

    [Windows] Example: C:\Program Files\IBM\WebSphere\eXtremeScale

  • Example when WebSphere eXtreme Scale is integrated with WebSphere Application Server:

    Example: /opt/IBM/WebSphere/AppServer

wxs_home
The wxs_home directory is the root directory of the WebSphere eXtreme Scale product libraries, samples, and components. This directory is the same as the wxs_install_root directory when the trial is extracted. For stand-alone installations, the wxs_home directory is the ObjectGrid subdirectory within the wxs_install_root directory. For installations that are integrated with WebSphere Application Server, this directory is the optionalLibraries/ObjectGrid directory within the wxs_install_root directory.
  • Example when extracting the trial:

    Example: /opt/IBM/WebSphere/eXtremeScale

  • Example when WebSphere eXtreme Scale is installed to a stand-alone directory:

    [Unix] Example: /opt/IBM/eXtremeScale/ObjectGrid

    [Windows] Example: wxs_install_root\ObjectGrid

  • Example when WebSphere eXtreme Scale is integrated with WebSphere Application Server:

    Example: /opt/IBM/WebSphere/AppServer/optionalLibraries/ObjectGrid

was_root
The was_root directory is the root directory of a WebSphere Application Server installation:

Example: /opt/IBM/WebSphere/AppServer

[.net programming language only][Version 8.6 and later] net_client_home
The net_client_home directory is the root directory of a .NET client installation.

Example: C:\Program Files\IBM\WebSphere\eXtreme Scale .NET Client

restservice_home
The restservice_home directory is the directory in which the WebSphere eXtreme Scale REST data service libraries and samples are located. This directory is named restservice and is a subdirectory under the wxs_home directory.
  • Example for stand-alone deployments:

    Example: /opt/IBM/WebSphere/eXtremeScale/ObjectGrid/restservice

    Example: wxs_home\restservice

  • Example for WebSphere Application Server integrated deployments:

    Example: /opt/IBM/WebSphere/AppServer/optionalLibraries/ObjectGrid/restservice

tomcat_root
The tomcat_root is the root directory of the Apache Tomcat installation.

Example: /opt/tomcat5.5

wasce_root
The wasce_root is the root directory of the WebSphere Application Server Community Edition installation.

Example: /opt/IBM/WebSphere/AppServerCE

java_home
The java_home is the root directory of a Java™ Runtime Environment (JRE) installation.

[Unix] Example: /opt/IBM/WebSphere/eXtremeScale/java

[Windows] Example: wxs_install_root\java

samples_home
The samples_home is the directory in which you extract the sample files that are used for tutorials.

[Unix] Example: wxs_home/samples

[Windows] Example: wxs_home\samples

dvd_root
The dvd_root directory is the root directory of the DVD that contains the product.

Example: dvd_root/docs/

equinox_root
The equinox_root directory is the root directory of the Eclipse Equinox OSGi framework installation.

Example:/opt/equinox

user_home
The user_home directory is the location where user files are stored, such as security profiles.

[Windows] c:\Documents and Settings\user_name

[Unix] /home/user_name