Configure WebSphere variables
Overview
WebSphere variables are name and value pairs that are used to provide settings for any of the string data type attributes contained in one of the XML formatted configuration files that reside in the product repository. After a variable is defined, the value specified for the variable replaces the variable name whenever the variable name is encountered during configuration processing.
WebSphere variables are usually used to specify file paths. However, some system components also support the use of these variables. The "Variable settings" topic supplies further details about specifying variables and highlights further details about WAS components that use them. WebSphere variables are also used to:
- Configure product path names, such as JAVA_HOME, and APP_INSTALL_ROOT.
- Configure certain cell-wide or cluster-wide customization values.
The scope of a variable can be cell-wide, cluster-wide, node-wide, or applicable to only one server process.
Define variables on the Environment > WebSphere Variables console page.
Define the scope to apply a variable cell-wide, cluster-wide, node-wide, or to only one server process. A variable resolves to its new value when used in a component that supports the use of variables.
Procedure
- Click Environment > WebSphere Variables in the administrative console to define a new variable.
- Specify the scope of the variable.
Declare the new variable for the Cell, Cluster, Node, or Server and click Apply.
The variable exists at the level you specify. Define a variable at multiple levels to use multiple values. The more granular definition overrides the higher level setting.
For instance, if you specify the same variable on a node and a server, the server setting overrides the node setting. Similarly, a cluster level setting overrides a node or cell setting.
Scoping variables is particularly important when testing data source objects. Variable scoping can cause a data source to fail the test connection, but to succeed at run time, or to pass the test connection, but fail at run time.
- Click New on the WebSphere Variables page.
- Specify a name, a value, and a description on the Variable page. Click OK.
- Verify that the variable is displayed in the list of variables. The console does not pick up typing errors. The variable is ignored if it is referred to incorrectly.
- Save the configuration.
- Stop the server and start the server again to put the variable configuration change into effect.
WebSphere variables collection
Variables
Configure the IBM Toolbox for Java
Related concepts
Variables
Test connection service
Related tasks
Set up the application serving environment
Related Reference
Session management custom properties
Related information
HTTP transport custom properties