Portal Express, Version 6.0
Operating systems: i5/OS, Linux, Windows
Configuration program
- Overview
- Using configuration tasks
- Using configuration templates
- Windows and Linux configuration templates
- i5/OS configuration templates
- Creating a configuration templates
Overview
There are several ways to configure WebSphere Portal Express.
- Some configuration tasks are run during the initial installation and configuration of WebSphere Portal Express.
- Other configuration tasks are invoked through a scripting interface.
Because configuration is separate from installation, you can modify the configuration without being required to reinstall WebSphere Portal Express.
For example, if you need to change the security model, you can update WebSphere Portal Express simply by running configuration tasks. Similarly, when you want to add a component to your environment, such as IBM® Lotus® Sametime®, you can install the component using the component's installation program and then run an appropriate configuration task or set of tasks that enables WebSphere Portal Express to use the new component. In addition you can use configuration tasks to change some run-time settings at any time.
Key elements in the configuration process are WebSphere Portal Express configuration property files, which contain values that are required for configuration.
You can modify the properties in these files if necessary to support the component you want to configure.
WebSphere Portal Express configuration properties files:
- wpconfig.properties
- wpconfig_dbdomain.properties
- wpconfig_dbtype.properties
These files are located in:
Windows and Linux: portal_server_root/config i5/OS: portal_server_root_user
Use configuration tasks
All configuration performed on WebSphere Portal Express is accomplished with configuration scripts referred to as configuration tasks. These configuration tasks can be run automatically (for example, by the installation program) or manually by the user. Values used for configuration are obtained from properties specified either in a properties file or as part of the task invocation itself.
The configuration tasks are implemented using the Apache Ant build tool, which is included with IBM WebSphere® Application Server.
When performing configuration of WebSphere Application Server, configuration tasks also invoke scripts, Java programs, and other configuration tasks.
WebSphere Portal Express provides a primary script file that you can use to invoke the configuration tasks:
Linux: ./WPSconfig.sh Windows: WPSconfig.bat i5/OS: WPSconfig.sh
You can run these scripts from...
Windows and Linux: portal_server_root/config i5/OS: portal_server_root_user/config
The syntax for invoking a configuration script is as follows:
- Linux:
./WPSconfig.sh task_name [task_name ...] [-Dproperty=value ...]
- Windows:
WPSconfig.bat task_name [task_name ...] [-Dproperty=value ...]
- i5/OS: From the UserData directory:
WPSconfig.sh -profileName profile_root task_name [task_name ...] [-Dproperty=value ...]
For example, to invoke the configuration task that creates the databases used by WebSphere Portal Express and indicate that tracing and logging messages generated by the task should be in English (using standard Java properties), you would use the following:
- Linux:
./WPSconfig.sh create-database -Duser.language=en -Duser.region=US
- Windows:
WPSconfig.bat create-database -Duser.language=en -Duser.region=US
- i5/OS: From the UserData directory:
WPSconfig.sh -profileName profile_root create-database -Duser.language=en -Duser.region=US
The properties you can modify are located in the files...
...in the directory...
portal_server_root/config
Running multiple configuration tasks concurrently is not supported.
Password Considerations: When running a configuration script you can include the appropriate password property and value on the command line or in the properties file. This documentation recommends that you do not store passwords in the properties file.
- Arguments that include spaces must be specified in the appropriate file (wpconfig.properties , wpconfig_dbdomain.properties, or wpconfig_dbtype.properties). They are not supported as -D arguments from the command line.
- When specifying a property value for a configuration task with the -D flag, the value persists only while that particular task is running. Although the value temporarily supersedes the value for that property in the wpconfig.properties, wpconfig_dbdomain.properties, and wpconfig_dbtype.properties files, it does not overwrite the value stored in the property file. If the same configuration task is invoked again, the value in the property file will be used unless it is overridden again with the -D flag.
- Once a property is set during configuration, its value cannot be overridden by later attempts to set it. The precedence order for setting properties is as follows, from highest precedence to lowest precedence:
- Properties set on the command line when the configuration task is launched
- Properties set in a parent properties file (see Using configuration templates for more information)
- Properties set in the wpconfig.properties file
- Properties set in the wpconfig_dbdomain.properties file
- Properties set in the wpconfig_dbtype.properties file
- Properties set in the XML configuration files themselves
- i5/OS:
Notice that there are also wpconfig.properties, wpconfig_dbdomain.properties, and wpconfig_dbtype.properties files in the ProdData directory (portal_server_root_user/config).
Each of these files serve as a template for their respective configuration properties, and are copied to the UserData directory when WebSphere Portal Express is added to a WebSphere Application Server profile. Do not modify these template files. Modifying these files will not affect any existing WebSphere Portal Express configurations.
Use configuration templates
When performing configuration tasks, WebSphere Portal Express derives the values for these tasks from the wpconfig.properties, wpconfig_dbdomain.properties, and wpconfig_dbtype.properties files. In addition to simplifying file management, the use of a single file for maintaining property values has the advantage of serving as a centralized reference for current configuration settings. However, depending on the task you want to perform, there might be many properties in the file that are unrelated to the task. In addition, the possible values for each property, which are often documented in the file, pertain to many different cases. For example, database properties are described for a number of different database types, although you would be interested in only one at any given time.
To make interaction with the wpconfig.properties, wpconfig_dbdomain.properties, and wpconfig_dbtype.properties files more convenient, WebSphere Portal Express includes configuration templates, which are condensed, special-purpose properties files. These templates provide only the properties needed for a given task and can also be tailored to a particular type of resource (for example, only for security).
The basis for the configuration templates is WebSphere Portal Express's support for the use of parent properties files. When you invoke a parent properties file during configuration, a property value from that file supersedes a value for the same property in the wpconfig.properties file. The use of a parent properties file is useful in situations where you want to perform the same configuration tasks on multiple machines, such that some of the properties in wpconfig.properties would be same for on all machines, while other properties might be different. For example, the security settings might be the same on each machine, while the user IDs and passwords might be different. In such a case, using a single main properties file (wpconfig.properties, wpconfig_dbdomain.properties, and wpconfig_dbtype.properties) to perform common tasks on each machine is not practical. By putting properties that are common across machines into a parent properties file, it is easier to ensure that each machine is configured in the same way.
To use a parent properties file when invoking a WebSphere Portal Express configuration task, specify the parentProperties property when launching the configuration program:
- Linux:
./WPSconfig.sh -DparentProperties=path_to_file/parent.properties -DSaveParentProperties=true task_name [task_name ...]
- Windows:
WPSconfig.bat -DparentProperties=path_to_file/parent.properties -DSaveParentProperties=true task_name [task_name ...]
- i5/OS: From the UserData directory:
WPSconfig.sh -profileName profile_root -DparentProperties=path_to_file/parent.properties -DSaveParentProperties=true task_name [task_name ...]
...where path_to_file is the path to the parent properties file, parent.properties is the name of the file, and task_name indicates the configuration task you want to run. In this example, if a property is specified in the security_ibm_dir_server.properties file, an attempt to set the property from the wpconfig.properties, wpconfig_dbdomain.properties, and wpconfig_dbtype.properties files, which are loaded later by the configuration program, will be ignored.
When using a parent properties file, if all the specified tasks execute successfully, the properties from the parent properties file will automatically be saved to the wpconfig.properties, wpconfig_dbdomain.properties, and wpconfig_dbtype.properties files. In this way, the wpconfig.properties, wpconfig_dbdomain.properties, and wpconfig_dbtype.properties files should always reflect the property values that were used for configuration.
Windows and Linux configuration templates
Configuration templates are essentially parent properties files that are provided with WebSphere Portal Express and are designed to support specific tasks or sets of tasks. For example, one configuration template might be used to configure WebSphere Portal Express for security with Domino® Directory.
Another configuration template might be used to configure WebSphere Portal Express for security with Tivoli Directory Server. Where possible, properties in these files are set to the most common default values, and only those values appropriate to the specific type of resource are included.
Comments within each configuration template summarize the tasks you need to perform with the configuration template and also include additional details regarding the template's use.
To use a configuration template, launch the configuration program and specify the configuration template as a parent properties file. For example, if you have edited security_ibm_dir_server.properties for your environment, you would invoke the configuration template from the portal_server_root/config directory as follows:
Do not remove the "config/" from the parentProperties setting; type the command as shown.
- Linux:
./WPSconfig.sh -DparentProperties=config/helpers/security_ibm_dir_server.properties -DSaveParentProperties=true
- Windows:
WPSconfig.bat -DparentProperties=config/helpers/security_ibm_dir_server.properties -DSaveParentProperties=true
When no task is specified, the configuration program simply updates thewpconfig.properties, wpconfig_dbdomain.properties, and wpconfig_dbtype.properties files with the values from the configuration template. This enables you to set up templates specific to a particular task for the purpose of entering the properties and then have those properties saved to wpconfig.properties, wpconfig_dbdomain.properties, and wpconfig_dbtype.properties files without being required to edit them directly.
WebSphere Portal Express provides several example configuration templates in the portal_server_root/config/helpers directory.
| Configuration template | Description |
|---|---|
| security_active_directory.properties | This template can be used to configure WebSphere Portal Express to use WebSphere Application Server security with Microsoft® Active Directory as its Lightweight Directory Access Protocol (LDAP) directory. |
| security_disable.properties | This template can be used to disable security for WebSphere Application Server if you have previously configured WebSphere Portal Express to use security. |
| security_domino.properties | This template can be used to configure WebSphere Portal Express to use WebSphere Application Server security with IBM Lotus Domino as its LDAP directory. |
| security_ibm_dir_server.properties | This template can be used to configure WebSphere Portal Express to use WebSphere Application Server security with IBM Tivoli® Directory Server as its LDAP directory. |
| security_novell.properties | This template can be used to configure WebSphere Portal Express to use WebSphere Application Server security with Novel as its LDAP directory. |
| security_sun_one.properties | This template can be used to configure WebSphere Portal Express to use WebSphere Application Server security with Sun Java System Directory Server as its LDAP directory. |
i5/OS configuration templates
Configuration templates are essentially parent properties files that are provided with WebSphere Portal Express and are designed to support specific tasks or sets of tasks. For example, a configuration template might be used to configure WebSphere Portal Express for security with IBM Directory Server. Where possible, properties in these files are set to the most common default values, and only those values appropriate to the specific type of resource are included. Comments within each configuration template summarize the tasks you need to perform with the configuration template and also include additional details regarding the template's use.
To use a configuration template, invoke the WPSconfig.sh script file and specify the configuration template as a parent properties file. For example, if you have edited config_http.properties for your environment, you would invoke the configuration template from the portal_server_root_user/config directory as follows: From the UserData directory:
WPSconfig.sh -profileName profile_root -DparentProperties=config/helpers/config_http.properties -DSaveParentProperties=true
WebSphere Portal Express provides several example configuration templates in the portal_server_root_user/config/helpers directory.
| Configuration Template | Description |
| config_http.properties | This template can be used to configure WebSphere Portal Express to use an external Web server, instead of the internal HTTP transport provided by WebSphere Application Server. |
| iseries_profile.properties | This template can be used to set just those properties that are specific to an i5/OS basic configuration. |
| security_active_directory.properties | This template can be used to configure WebSphere Portal Express to use WebSphere Application Server security with Active Directory as its Lightweight Directory Access Protocol (LDAP) directory. |
| security_disable.properties | This template can be used to disable security for WebSphere Application Server if you have previously configured WebSphere Portal Express to use security. |
| security_domino.properties | This template can be used to configure WebSphere Portal Express to use WebSphere Application Server security with Domino as its LDAP directory. |
| security_ibm_dir_server.properties | This template can be used to configure WebSphere Portal Express to use WebSphere Application Server security with IBM Directory Server as its LDAP directory. |
| security_sun_one.properties | This template can be used to configure WebSphere Portal Express to use WebSphere Application Server security with Sun Java System Directory Server as its LDAP directory. |
Create a configuration templates
In addition to using the configuration templates provided with WebSphere Portal Express, you can create a configuration templates if you find it useful to do so. For example, if you found that you were commonly doing the same task across many WebSphere Portal Express nodes in your enterprise, you could create your own configuration template to make it easier to correctly perform this task on each node. Follow the conventions depicted in the example configuration template files for adding comments, specifying property values, and so on.
Related information
- Configuration properties reference
This topic describes the properties that are used with the configuration tasks during installation and configuration.
- Configuration task reference
This topic explains the configuration tasks that are part of the WebSphere Portal Express installation process.
- Deleting passwords from configuration scripts
This topic provides information on removing passwords from configuration scripts after WebSphere Portal Express has been installed and configured.