Before using this information and the product it supports, read the information in Notices.
This edition applies to version 9, release 1, modification 0 of IBM InfoSphere Optim solution components and to all subsequent releases and modifications until otherwise indicated in new editions.
This document describes how to install and configure IBM® InfoSphere® Optim™ solution components.
Use IBM InfoSphere Optim solution components to develop, configure, and run InfoSphere Optim services.
IBM InfoSphere Optim Designer is an Eclipse-based development environment that can be used to develop and test data management services. InfoSphere Optim Designer is also known as the designer.
The designer can be installed only on Microsoft Windows workstations.
The designer must be installed with IBM InfoSphere Optim Runtime Services to work. The designer can be installed with IBM InfoSphere Data Architect in a "shell sharing" configuration, but the designer does not require InfoSphere Data Architect.
IBM InfoSphere Optim Manager is a web application that you can use to configure, manage, run, and monitor data management services.InfoSphere Optim Manager is also known as the manager.
You can access and use the manager to run services from the designer.
The manager can also be deployed to a Java™ EE-compliant application server so that users do not need to install the designer to test and run services. InfoSphere Optim components are delivered with a version of WebSphere® Application Server Community Edition that you can use for the connection manager and the manager. You do not need to deploy the manager to an application server to use the manager from the designer.
InfoSphere Optim Manager is installed by IBM Installation Manager as part of the IBM InfoSphere Optim Web Applications package.
IBM InfoSphere Optim Runtime Services is the component that contains the server and the pr0cmnd command-line interface. When installed on a Microsoft Windows computer, InfoSphere Optim Runtime Services also contains an alternative interface that can be used to develop and run services. InfoSphere Optim Runtime Services is also known as runtime services.
The server is the component that processes service requests. The server receives service requests, reads data from data sources, and writes data to data sources according to the instructions found in each service request.
The server is part of IBM InfoSphere Optim Runtime Services. For fast performance, install InfoSphere Optim Runtime Services on a computer that is near to the data sources that you are processing.
Optim Service Interface is a web application that can be used by other applications to run, monitor, and manage services. Optim Service Interface is also known as the service interface.
The service interface accepts HTTP requests and XML request payloads where applicable. The service interface processes the request and returns an HTTP response code and output document where applicable.
Optim Service Interface is installed by IBM Installation Manager as part of the IBM InfoSphere Optim Web Applications package.
IBM InfoSphere Optim Connection Manager is a web application that stores Optim directory connection information for InfoSphere Optim components. InfoSphere Optim Connection Manager is also known as the connection manager.
The connection manager can be deployed to a Java EE-compliant application server. InfoSphere Optim components are delivered with a version of WebSphere Application Server Community Edition that you can use for the connection manager and the manager.
InfoSphere Optim Connection Manager is installed by IBM Installation Manager as part of the IBM InfoSphere Optim Web Applications package.
Components must work together to complete a service request successfully.
The diagram shows how components work together to run a service:
IBM InfoSphere Optim solution components are installed by using IBM Installation Manager. For detailed information about how to use Installation Manager, see the Installation Manager Information Center.
Before you install IBM InfoSphere Optim solution components, plan how the components are to be installed and learn how the components are packaged in IBM Installation Manager. Also, review the system requirements for InfoSphere Optim solution components.
There are two main scenarios for installing InfoSphere Optim solutions: installing for test or evaluation purposes and installing for production use.
Install all components on a single Microsoft Windows computer to evaluate the software or to test the suitability of the software for a specific purpose.
An evaluation or proof-of-concept installation also requires a database on which you can create an Optim directory. The database can be on a different computer from the Optim components. However, you must install driver software for the database on the computer and configure the driver to access the database. You must also install database drivers for any other databases that you want to access or manage.
For a production environment installation, the components are installed on multiple computers to increase performance and enable collaboration.
The following types of installations are used in a production environment:
A production environment installation also requires one or more databases on which you can create Optim directories. The databases can be on different computer from the other components. However, you must install driver software for the database on each workstation and server computer and configure the driver to access the database. You must also load a JDBC driver for the database onto the web application server and configure the connection manager to use the driver.
The following installation types typically contain the indicated components and database drivers:
IBM Installation Manager uses installation packages to install InfoSphere Optim solution components. A package is an installable unit of a software product.
Installation packages can be installed in any order. In an evaluation or proof-of-concept installation, where all components are installed on a single Microsoft Windows computer, install all packages at the same time. However, you must run the Optim Configuration program to configure the first workstation before you configure or use any other component. The Optim Configuration program is launched by default after installation is complete. After you configure the first workstation, deploy and configure the connection manager.
The following Installation Manager installation packages are delivered with InfoSphere Optim solutions:
Optim Designer Online Help can be installed only with InfoSphere Optim Designer or on computers that already have InfoSphere Optim Designer. All other packages can be installed individually.
IBM InfoSphere Data Architect installation media is also included with InfoSphere Optim solutions. InfoSphere Optim Designer can be installed with InfoSphere Data Architect in a shell-sharing configuration, where InfoSphere Optim Designer and InfoSphere Data Architect share an Eclipse platform. For information about installing InfoSphere Data Architect, see the InfoSphere Data Architect information center.
A package group is a group of one or more packages that are designed to work together and that can be installed to one directory. When you install a package with Installation Manager, you can create a new package group or install the packages into an existing package group. (Some packages cannot share a package group, in which case the option to use an existing package group is disabled.)
The following package groups are used for InfoSphere Optim solution components.
Before installation, review the system requirements for each InfoSphere Optim solution component. Careful review
Before you install the product, verify that your hardware and software meet or exceed the minimum requirements. If your hardware and software do not meet the minimum requirements, you might be unable to install or run the product.
For the most up to date IBM InfoSphere Optim system requirements, see the technote on the Web: http://www.ibm.com/support/docview.wss?uid=swg27024294.
You must have a user ID that meets specific requirements before you can install your product.
Your user ID must not contain double-byte characters.
There are two methods of installation: administrative and non-administrative.
The following table describes what happens when user IDs with different access privileges are used when installing.
User ID authority | Case where you install as Non-administrative | Case where you install as Administrative |
---|---|---|
Non-administrative (current user) |
|
|
Administrative | An error message occurs. |
|
Understanding these terms and conventions can help you take full advantage of the installation information and your product.
These terms are used in the installation topics.
If you are installing InfoSphere Optim Solution components for the first time, the easiest way to install the components is to use the launchpad.
The launchpad requires a graphical user interface and a web browser. If the computer does not have a graphical user interface and a web browser, install IBM Installation Manager and the components in console mode.
Before you install any components on a computer, ensure that the computer can access the databases that you are to use (such as for Optim directories).
If you are installing the components for a workstation or a server, obtain the license information for your solution:
You must also have a license key to install the components for a workstation. If you do not yet have this information, you can use a trial license for a limited time before you are required to enter the license information.
If you are installing the components for a web application server, choose the Java EE-compliant application server that is to be used for the web applications. The web applications are delivered with a partially configured version of IBM WebSphere Application Server Community Edition. If you do not use this version of WebSphere Application Server Community Edition, you must install a different application server.
To install InfoSphere Optim Solution components from the launchpad:
If you install the components for a workstation or a server, Installation Manager starts a separate installation process when runtime services is installed. You must complete this separate installation process before Installation Manager can complete installation.
At the end of the runtime services installation on Windows, the Optim Configuration program runs unless you choose not to run the program. You must complete the Optim Configuration program on at least one workstation before you can configure or use any other component.
Install InfoSphere Optim solution components in console mode if the computer does not have both a graphical user interface and a web browser. Use the launchpad to install InfoSphere Optim solution components on a computer that has a graphical user interface and a web browser, such as a Microsoft Windows computer.
Before you install any components on a computer, ensure that the computer can access the database that you are to use for the Optim directory.
If you are installing the components for a web application server, choose the Java EE-compliant application server that is to be used for the web applications. The web applications are delivered with a partially configured version of IBM WebSphere Application Server Community Edition. If you do not use this version of WebSphere Application Server Community Edition, you must install a different application server.
To install InfoSphere Optim Solution components in console mode:
If you plan to install a similar configuration on multiple computers, you can automate the installation process by configuring IBM Installation Manager response files. The response files can be used to install components in silent mode.
Copy the launchpad image to a location that you can edit and that all users can access.
You must install Installation Manager before you install InfoSphere Optim solution components silently. The location of the Installation Manager installation files for each operating system is indicated in the following table.
Operating system | Launchpad location of Installation Manager installation files |
---|---|
Microsoft Windows | \win32 |
Linux | /linux86 |
IBM AIX® | /aixppc |
Oracle Solaris | /solarissparc |
HP-UX | /hpuxia64 |
For information on how to install Installation Manager, see the Installation Manager information center.
Before you install any components on a computer, ensure that the computer can access the databases that you are to use (such as for Optim directories).
If you are installing the components for a workstation or a server, obtain the license information for your solution:
You must also have a license key to install the components for a workstation. If you do not yet have this information, you can use a trial license for a limited time before you are required to enter the license information.
If you are installing the components for a web application server, choose the Java EE-compliant application server that is to be used for the web applications. The web applications are delivered with a partially configured version of IBM WebSphere Application Server Community Edition. If you do not use this version of WebSphere Application Server Community Edition, you must install a different application server.
To install InfoSphere Optim solution components silently:
Packages | Sample response file |
---|---|
|
installDesignerOLHelp.xml |
IBM InfoSphere Optim Runtime Services | installRuntime.xml |
IBM WebSphere Application Server Community Edition | installWASCE.xml |
IBM InfoSphere Optim Web Applications | installWeb.xml |
Operating system | Sample response file |
---|---|
Microsoft Windows | optim_installer_win.properties |
Linux or UNIX | optim_installer_unix.properties |
Operating system | Sample response file |
---|---|
Microsoft Windows | SilentInstall.bat |
Linux or UNIX | SilentInstall.sh |
The connection manager, the manager, and the service interface are web applications that must be deployed to a Java EE-compliant application server.
Security for the manager depends upon the environment from which you launch the manager. When you deploy the manager to an application server, security for the manager depends upon the security settings of the application server. When you launch the manager from the designer, you can run, publish, or export any service within the designer workspace to any available registry.
When you deploy the manager to an application server, use the application server to set up user authentication for the manager. The manager can use any authentication method that is supported by the application server. Regardless of the authentication method that you use on the application server, you must use the roles that are supported by the manager.
When you deploy the manager to an application server, the manager uses a predefined set of user roles. User roles define the tasks that each user can perform. Although user credentials are set up in the application server, the user credentials must use the roles that are supported by the manager.
The manager supports the user roles that are listed in the following table. The administrator of the application server must map roles to user credentials so that users can sign onto the manager.
Role ID | Role name | Description of role |
---|---|---|
0 | admin | The administrator of the manager, who configures and maintains services. Administrators are also the only users that can access the connection manager. |
1 | requester | The test analyst, who makes requests that are to be fulfilled by others. |
2 | reviewer | The business analyst, who reviews service requests to ensure that the requests are made for valid business reasons. |
3 | designer | The service designer, who creates and tests services. |
4 | operator | The operator, who runs and schedules services. |
You can assign more than one user role to a single user. Each user role that you assign to a user gives the user access to the functions that are associated with the user role. For example, you assign the reviewer user role and the designer user role to a single user. For such a user, the user has access to the functions that are associated with both user roles.
For some product solutions, the manager might support the creation of user accounts that are based on user accounts on an external system. These product solutions might require you to create user accounts in this way to use the integration between the manager and the external system. When you use the manager to create such a user, you can assign any combination of user roles to the user.
User roles are only one element of security that is provided by the manager. If a service is added to a service group, a user must be granted access to the service group before the user can run the service. Also, an administrator can configure tabs so that the tabs cannot be accessed by users who do not have a user role of admin. In these cases, a user might not be able to perform tasks that would otherwise be allowed by the user role.
Each user role gives users permission to perform a set of tasks that are appropriate to users with that user role. The following tables indicate which tasks can be performed by users that have each user role.
Tasks | Roles |
---|---|
View Servers on the Configuration tab | admin, designer, operator |
View Users and Groups, Tabs, and Work Orders on the Configuration tab | admin |
Set global preferences | admin |
Set user and display preferences | admin, designer, operator, requester, reviewer |
Manage groups of services | admin |
Grant and remove user access to groups of services | admin |
Enable email notifications for work order changes | admin |
Assign email addresses to users | admin |
Manage user-defined tabs | admin |
Change access to tabs in the manager | admin |
Change the workflow for work orders | admin |
Tasks | Roles |
---|---|
View the Service Management tab | admin, designer, operator |
Run services and service sets | admin, designer, operator |
Schedule services and service sets | admin, designer, operator |
Change service input values | admin, designer, operator |
Manage service sets (create, edit, delete) | admin, designer, operator |
Assign services to a server | admin, operator |
Tasks | Roles |
---|---|
View the Dashboard and Service Monitoring tabs | admin, designer, operator |
Stop services | admin, designer, operator |
Restart services | admin, designer, operator |
Purge service instance information | admin |
Manage service instance filters | admin |
Tasks | Roles |
---|---|
View Work Order Management and Work Order Monitoring on the Work Orders tab | admin, designer, operator, requester, reviewer |
Create a work order | admin, reviewer |
Add a comment to a work order | admin, designer, operator, requester, reviewer |
Approve a work order for development | admin, reviewer |
Deny a work order and return the work order to a requester | admin, reviewer |
Resubmit a work order to a reviewer or designer | admin, requester |
Associate a work order with a service or service set | admin, designer |
Change the service or service set that is associated with a work order | admin, designer |
Reject a work order and return the work order to a requester | admin, designer |
Run a service or service set that is associated with a work order | admin, designer, operator, requester, reviewer |
Return a work order to a designer | admin, requester |
Terminate or close a work order | admin, requester |
The tasks that you must perform to configure InfoSphere Optim web applications depend upon the application server that you use. InfoSphere Optim web applications are delivered with a preconfigured version of WebSphere Application Server Community Edition. Use this version of WebSphere Application Server Community Edition to install and configure InfoSphere Optim web applications more quickly and easily for evaluation purposes.
The version of WebSphere Application Server Community Edition that is delivered with InfoSphere Optim web applications is available only in English. You must configure this version of WebSphere Application Server Community Edition by using an English user interface. However, when you use the connection manager or the manager, the language setting of the browser determines the language of the user interface.
The configuration roadmap lists the high-level steps for configuring the connection manager, the manager, and the service interface.
Perform these tasks to configure the connection manager, the manager, and the service interface on the version of WebSphere Application Server Community Edition that is delivered with the web applications.
If you use WebSphere Application Server Community Edition for your web applications, you must start WebSphere Application Server Community Edition before you configure or use the web applications.
To start WebSphere Application Server Community Edition, complete the step that is appropriate for your operating system:
InfoSphere Optim web applications can connect to an Optim directory only if the application server has a Java Database Connectivity (JDBC) driver for the Optim directory database. Use this task to install JDBC drivers for other vendors on the English version of WebSphere Application Server Community Edition.
Start WebSphere Application Server Community Edition before you install a JDBC driver on WebSphere Application Server Community Edition.
Use the Administrative Console of WebSphere Application Server Community Edition to install a JDBC driver. The default location of the Administrative Console is http://hostname:8080/console, where hostname is the host name of the computer on which WebSphere Application Server Community Edition is installed.
When you install a JDBC driver, you must identify the driver to the application server by specifying the following information:
To install a JDBC driver on WebSphere Application Server Community Edition:
When you deploy the connection manager and the manager to WebSphere Application Server Community Edition, configuration information is typically stored in a database pool. You must also configure a security realm to specify how user information is configured for the connection manager and the manager.
Start WebSphere Application Server Community Edition before you configure the database pool and security realm for the connection manager and the manager.
The database pool for the connection manager and the manager must be created in a supported database. The database pool must be in a different schema than the schema used by any Optim directory.
Use the Administrative Console of WebSphere Application Server Community Edition to configure the database pool. The default location of the Administrative Console is http://hostname:8080/console, where hostname is the host name of the computer on which WebSphere Application Server Community Edition is installed.
To configure the database pool and security realm for the connection manager and the manager on WebSphere Application Server Community Edition:
You must deploy the connection manager Web archive (WAR) file to the application server before you can use the connection manager. Use this task to deploy the WAR file on the English version of WebSphere Application Server Community Edition.
Start WebSphere Application Server Community Edition before you deploy the WAR file.
Use the Administrative Console of WebSphere Application Server Community Edition to deploy the WAR file. The default location of the Administrative Console is http://hostname:8080/console, where hostname is the host name of the computer on which WebSphere Application Server Community Edition is installed.
To deploy the connection manager WAR file with the Administrative Console of WebSphere Application Server Community Edition:
If the WAR file fails to deploy because of java.lang.OutOfMemoryError: PermGen space errors, increase the amount of permanent generation memory available for objects in the Java Virtual Machine (VM) on the application server. To increase the available amount of permanent generation memory, open the application server startup script in a text editor and adjust the PermSize and MaxPermSize arguments in the JAVA_OPTS parameter. The PermSize argument specifies the initial amount of permanent generation memory, and the MaxPermSize argument specifies the maximum amount of permanent generation memory. By default, the manager uses 64 MB of permanent generation memory. Setting memory sizes to a value larger than the amount of available physical memory on your computer severely degrades performance. For example, the following JAVA_OPTS parameter from a Windows batch script specifies 128 MB as the initial amount of permanent generation memory and 256 MB as the maximum amount of permanent generation memory.
@set JAVA_OPTS=%ADDITIONAL_JAVA_OPTS% %JAVA_OPTS% ^
-XX:PermSize=128m -XX:MaxPermSize=256m
The following JAVA_OPTS parameter from a Linux or UNIX script specifies 128 MB as the initial amount of permanent generation memory and 256 MB as the maximum amount of permanent generation memory.
JAVA_OPTS=-XX:PermSize=128m -XX:MaxPermSize=256m \
$JAVA_OPTS
If the JAVA_OPTS parameter or the PermSize and MaxPermSize arguments are not in the application server startup script, add the parameter and arguments to the end of the script. Ensure that the JAVA_OPTS parameter is on a single line or on consecutive lines that are connected with line-continuation characters. The line-continuation character is the caret (^) for Windows batch scripts or the backslash (\) for Linux or UNIX scripts. Also, include the %JAVA_OPTS% or $JAVA_OPTS argument in the JAVA_OPTS parameter so that the arguments that exist for the parameter are preserved.
If the application server computer is set to a language that requires the use of double-byte characters, configure the application server to use UTF-8 encoding in its log files. To configure the application server to use UTF-8 encoding, add the following argument to the end of the JAVA_OPTS parameter in the application server startup script. The entire JAVA_OPTS parameter must be either on a single line or on consecutive lines that are connected with line-continuation characters. The line-continuation character is the caret (^) for Windows batch scripts or the backslash (\) for Linux or UNIX scripts.
-Dfile.encoding=UTF-8
If the WAR file fails to deploy to a Linux computer because of IOException: too many open files errors, increase the maximum number of open files on the computer. To increase the maximum number of open files, sign on as superuser and complete the following steps.
/sbin/sysctl -w fs.file-max=100000
fs.file-max = 100000
/sbin/sysctl -p
/sbin/sysctl fs.file-max
ulimit -n 20048
ulimit -n 20048
After you change the application server startup script, you must restart the application server for changes to take effect.
You must deploy the manager Web archive (WAR) file to the application server before you can use the manager. Use this task to deploy the WAR file on the English version of WebSphere Application Server Community Edition.
Start WebSphere Application Server Community Edition before you deploy the WAR file.
Deploy the connection manager WAR file before you deploy the manager WAR file.
Use the Administrative Console of WebSphere Application Server Community Edition to deploy the WAR file. The default location of the Administrative Console is http://hostname:8080/console, where hostname is the host name of the computer on which WebSphere Application Server Community Edition is installed.
To deploy the manager WAR file with the Administrative Console of WebSphere Application Server Community Edition:
If the WAR file fails to deploy because of java.lang.OutOfMemoryError: PermGen space errors, increase the amount of permanent generation memory available for objects in the Java Virtual Machine (VM) on the application server. To increase the available amount of permanent generation memory, open the application server startup script in a text editor and adjust the PermSize and MaxPermSize arguments in the JAVA_OPTS parameter. The PermSize argument specifies the initial amount of permanent generation memory, and the MaxPermSize argument specifies the maximum amount of permanent generation memory. By default, the manager uses 64 MB of permanent generation memory. Setting memory sizes to a value larger than the amount of available physical memory on your computer severely degrades performance. For example, the following JAVA_OPTS parameter from a Windows batch script specifies 128 MB as the initial amount of permanent generation memory and 256 MB as the maximum amount of permanent generation memory.
@set JAVA_OPTS=%ADDITIONAL_JAVA_OPTS% %JAVA_OPTS% ^
-XX:PermSize=128m -XX:MaxPermSize=256m
The following JAVA_OPTS parameter from a Linux or UNIX script specifies 128 MB as the initial amount of permanent generation memory and 256 MB as the maximum amount of permanent generation memory.
JAVA_OPTS=-XX:PermSize=128m -XX:MaxPermSize=256m \
$JAVA_OPTS
If the JAVA_OPTS parameter or the PermSize and MaxPermSize arguments are not in the application server startup script, add the parameter and arguments to the end of the script. Ensure that the JAVA_OPTS parameter is on a single line or on consecutive lines that are connected with line-continuation characters. The line-continuation character is the caret (^) for Windows batch scripts or the backslash (\) for Linux or UNIX scripts. Also, include the %JAVA_OPTS% or $JAVA_OPTS argument in the JAVA_OPTS parameter so that the arguments that exist for the parameter are preserved.
If the application server computer is set to a language that requires the use of double-byte characters, configure the application server to use UTF-8 encoding in its log files. To configure the application server to use UTF-8 encoding, add the following argument to the end of the JAVA_OPTS parameter in the application server startup script. The entire JAVA_OPTS parameter must be either on a single line or on consecutive lines that are connected with line-continuation characters. The line-continuation character is the caret (^) for Windows batch scripts or the backslash (\) for Linux or UNIX scripts.
-Dfile.encoding=UTF-8
If the WAR file fails to deploy to a Linux computer because of IOException: too many open files errors, increase the maximum number of open files on the computer. To increase the maximum number of open files, sign on as superuser and complete the following steps.
/sbin/sysctl -w fs.file-max=100000
fs.file-max = 100000
/sbin/sysctl -p
/sbin/sysctl fs.file-max
ulimit -n 20048
ulimit -n 20048
After you change the application server startup script, you must restart the application server for changes to take effect.
You must deploy the service interface Web archive (WAR) file to the application server before you can use the interface. Use this task to deploy the WAR file on the English version of WebSphere Application Server Community Edition.
Start WebSphere Application Server Community Edition before you deploy the WAR file.
Deploy the connection manager WAR file before you deploy the service interface WAR file.
Use the Administrative Console of WebSphere Application Server Community Edition to deploy the WAR file. The default location of the Administrative Console is http://hostname:8080/console, where hostname is the host name of the computer on which WebSphere Application Server Community Edition is installed.
To deploy the service interface WAR file with the Administrative Console of WebSphere Application Server Community Edition:
If the WAR file fails to deploy because of java.lang.OutOfMemoryError: PermGen space errors, increase the amount of permanent generation memory available for objects in the Java Virtual Machine (VM) on the application server. To increase the available amount of permanent generation memory, open the application server startup script in a text editor and adjust the PermSize and MaxPermSize arguments in the JAVA_OPTS parameter. The PermSize argument specifies the initial amount of permanent generation memory, and the MaxPermSize argument specifies the maximum amount of permanent generation memory. By default, the manager uses 64 MB of permanent generation memory. Setting memory sizes to a value larger than the amount of available physical memory on your computer severely degrades performance. For example, the following JAVA_OPTS parameter from a Windows batch script specifies 128 MB as the initial amount of permanent generation memory and 256 MB as the maximum amount of permanent generation memory.
@set JAVA_OPTS=%ADDITIONAL_JAVA_OPTS% %JAVA_OPTS% ^
-XX:PermSize=128m -XX:MaxPermSize=256m
The following JAVA_OPTS parameter from a Linux or UNIX script specifies 128 MB as the initial amount of permanent generation memory and 256 MB as the maximum amount of permanent generation memory.
JAVA_OPTS=-XX:PermSize=128m -XX:MaxPermSize=256m \
$JAVA_OPTS
If the JAVA_OPTS parameter or the PermSize and MaxPermSize arguments are not in the application server startup script, add the parameter and arguments to the end of the script. Ensure that the JAVA_OPTS parameter is on a single line or on consecutive lines that are connected with line-continuation characters. The line-continuation character is the caret (^) for Windows batch scripts or the backslash (\) for Linux or UNIX scripts. Also, include the %JAVA_OPTS% or $JAVA_OPTS argument in the JAVA_OPTS parameter so that the arguments that exist for the parameter are preserved.
If the application server computer is set to a language that requires the use of double-byte characters, configure the application server to use UTF-8 encoding in its log files. To configure the application server to use UTF-8 encoding, add the following argument to the end of the JAVA_OPTS parameter in the application server startup script. The entire JAVA_OPTS parameter must be either on a single line or on consecutive lines that are connected with line-continuation characters. The line-continuation character is the caret (^) for Windows batch scripts or the backslash (\) for Linux or UNIX scripts.
-Dfile.encoding=UTF-8
If the WAR file fails to deploy to a Linux computer because of IOException: too many open files errors, increase the maximum number of open files on the computer. To increase the maximum number of open files, sign on as superuser and complete the following steps.
/sbin/sysctl -w fs.file-max=100000
fs.file-max = 100000
/sbin/sysctl -p
/sbin/sysctl fs.file-max
ulimit -n 20048
ulimit -n 20048
After you change the application server startup script, you must restart the application server for changes to take effect.
You can configure the version of WebSphere Application Server Community Edition that is delivered with the web applications as a service or daemon. The service or daemon (and any web applications that are deployed to WebSphere Application Server Community Edition) can then be set to start automatically on system startup.
WebSphere Application Server Community Edition is not available on HP-UX.
You can configure the version of WebSphere Application Server Community Edition that is delivered with the manager and the service interface as a Windows service. The Windows service can then be set to start automatically on system startup. If the manager and the service interface are deployed to WebSphere Application Server Community Edition, the manager and the service interface also start automatically on system startup.
Before you begin, install and deploy the manager to WebSphere Application Server Community Edition. You can also optionally deploy the service interface to WebSphere Application Server Community Edition.
The computer must have Microsoft .NET Framework 2.0 or higher installed.
To configure WebSphere Application Server Community Edition as a Windows service:
cd server_location/bin
appServerService.exe install
appServerService.exe start
You can check on the progress of WebSphere Application Server Community Edition by looking at the contents of log files. There are 3 log files:
To stop and uninstall the service, enter the following commands at the command prompt.
cd server_location/bin
appServerService.exe stop
appServerService.exe uninstall
You can configure the version of WebSphere Application Server Community Edition that is delivered with the manager and the service interface as an AIX daemon process. The daemon process can then be set to start automatically on system startup. If the manager and the service interface are deployed to WebSphere Application Server Community Edition, the manager and the service interface also start automatically on system startup.
You must have access to a superuser or root account to complete this task.
To configure WebSphere Application Server Community Edition as a daemon on an AIX computer:
cd server_location/bin
./setup-wasce-as-daemon.sh
The script generates a script called optimappserver,
which is saved to the server_location/bin directory.cd /etc/rc.d/init.d
chmod 755 optimappserver
ln -s optimappserver /etc/rc.d/rc2.d/S99optimappserver
ln -s optimappserver /etc/rc.d/rc2.d/K01optimappserver
To start the daemon, log in as superuser and enter the following command at the command prompt.
/etc/rc.d/init.d/optimappserver start
To stop the daemon, log in as superuser and enter the following command at the command prompt.
/etc/rc.d/init.d/optimappserver stop
To remove the daemon, log in as superuser and enter the following commands at the command prompt. Remove the daemon before you uninstall WebSphere Application Server Community Edition.
/etc/rc.d/init.d/optimappserver stop
rm /etc/rc.d/rc2.d/S99optimappserver
rm /etc/rc.d/rc2.d/K01optimappserver
rm /etc/rc.d/init.d/optimappserver
You can configure the version of WebSphere Application Server Community Edition that is delivered with the manager and the service interface as a Linux daemon process. The daemon process can then be set to start automatically on system startup. If the manager and the service interface are deployed to WebSphere Application Server Community Edition, the manager and the service interface also start automatically on system startup.
You must have access to a superuser or root account to complete this task.
To configure WebSphere Application Server Community Edition as a daemon on a Linux computer:
cd server_location/bin
./setup-wasce-as-daemon.sh
The script generates a script called optimappserver,
which is saved to the server_location/bin directory.cd /etc/rc.d/init.d
chmod 755 optimappserver
/sbin/chkconfig --add optimappserver
To start the daemon, log in as superuser and enter the following command at the command prompt.
/sbin/service optimappserver start
To view the init levels at which the daemon is started or stopped, log in as superuser and enter the following command at the command prompt.
/sbin/chkconfig --list optimappserver
To stop the daemon, log in as superuser and enter the following command at the command prompt.
/sbin/service optimappserver stop
To remove the daemon, log in as superuser and enter the following commands at the command prompt. Remove the daemon before you uninstall WebSphere Application Server Community Edition.
/sbin/service optimappserver stop
/sbin/chkconfig --del optimappserver
rm /etc/rc.d/init.d/optimappserver
You can configure the version of WebSphere Application Server Community Edition that is delivered with the manager and the service interface as a Solaris daemon process. The daemon process can then be set to start automatically on system startup. If the manager and the service interface are deployed to WebSphere Application Server Community Edition, the manager and the service interface also start automatically on system startup.
You must have access to a superuser or root account to complete this task.
To configure WebSphere Application Server Community Edition as a daemon on a Solaris computer:
cd server_location/bin
./setup-wasce-as-daemon.sh
The script generates a script called optimappserver,
which is saved to the server_location/bin directory.cd /etc/init.d
chmod 755 optimappserver
ln -s optimappserver /etc/rc3.d/S99optimappserver
ln -s optimappserver /etc/rc3.d/K01optimappserver
To start the daemon, log in as superuser and enter the following command at the command prompt.
/etc/init.d/optimappserver start
To stop the daemon, log in as superuser and enter the following command at the command prompt.
/etc/init.d/optimappserver stop
To remove the daemon, log in as superuser and enter the following commands at the command prompt. Remove the daemon before you uninstall WebSphere Application Server Community Edition.
/etc/init.d/optimappserver stop
rm /etc/rc3.d/S99optimappserver
rm /etc/rc3.d/K01optimappserver
rm /etc/init.d/optimappserver
If you use the default user security configuration for the manager on WebSphere Application Server Community Edition, user security information is stored in a database. You can use SQL commands to maintain user accounts in this database. Use this task to create a user account on this database.
Start WebSphere Application Server Community Edition before you add a user account for the manager.
Add user accounts for the manager only if you are using the default user security configuration for the manager. The default user security configuration might not be secure enough for production use.
For some product solutions, the manager might support the creation of user accounts that are based on user accounts on an external system. For these product solutions, create user accounts through the manager user interface so that you can fully use the integration with the external system. If you do not use such a product solution, create new user accounts by following the established security environment for the application server.
Before you can add a user account, deploy the manager web archive (WAR) file to WebSphere Application Server Community Edition.
Use the Administrative Console of WebSphere Application Server Community Edition to add a user account for the manager. The default location of the Administrative Console is http://hostname:8080/console, where hostname is the host name of the computer on which WebSphere Application Server Community Edition is installed.
To add a user account for the manager by using the Administrative Console of WebSphere Application Server Community Edition:
INSERT INTO MGR_OOB_USER values(userid,username,password);
INSERT INTO MGR_OOB_USER_ROLE values(userid,roleid,rolename);
For example, the following SQL code creates a user ID with the admin user role and a user ID with the operator user role. Both user IDs use passw0rd as the password.
INSERT INTO MGR_OOB_USER values(10,'administrator','passw0rd');
INSERT INTO MGR_OOB_USER_ROLE values(10,0,'admin');
INSERT INTO MGR_OOB_USER values(11,'user14','passw0rd');
INSERT INTO MGR_OOB_USER_ROLE values(11,4,'operator');
The manager can notify users of work order status changes by sending emails to users. To use this feature, you must configure the application server to use an email server before you deploy the manager to the application server.
You can use either of the following methods to configure the application server for work order notification by email:
To configure the application server for work order notification by email:
<init-param>
<param-name>mailSMTPHost</param-name>
<param-value>@smtphost@</param-value>
</init-param>
<init-param>
<param-name>mailSMTPPort</param-name>
<param-value>@smtpport@</param-value>
</init-param>
<init-param>
<param-name>mailSMTPAuth</param-name>
<param-value>@smtpauth@</param-value>
</init-param>
<init-param>
<param-name>mailSMTPUser</param-name>
<param-value>@smtpuser@</param-value>
</init-param>
<init-param>
<param-name>mailSMTPPwd</param-name>
<param-value>@smtppwd@</param-value>
</init-param>
<init-param>
<param-name>mailSMTPDebug</param-name>
<param-value>@smtpdebug@</param-value>
</init-param>
<resource-ref>
<res-ref-name>mail/MailSession</res-ref-name>
<res-type>javax.mail.Session</res-type>
<res-auth>Container</res-auth>
<res-sharing-scope>Shareable</res-sharing-scope>
</resource-ref>
You can now use the manager to enable email notification for work order changes.
The connection manager is a web application that stores Optim directory connection information for InfoSphere Optim components. To connect InfoSphere Optim components with an Optim directory, access the connection manager and configure the connection information. You might also need to upload Java Database Connectivity (JDBC) drivers to the connection manager so that the connection manager can access the Optim directory.
Use a web browser to access the connection manager.
You must use a manager user account with admin access to access the connection manager.
To access the connection manager, go to http://hostname:port/ocm/admin, where hostname and port are the host name and port of the application server on which the connection manager is deployed. If you deploy the connection manager to the version of WebSphere Application Server Community Edition that is delivered with the connection manager, then the default port is 8443. Your browser might warn you of a problem with the website's security certificate. This is expected if you use SSL to access a web application that uses a self-signed certificate. Choose to continue to the website.
If you cannot access the connection manager, ensure that the following statements are true.
Bookmark the location of the connection manager for future access.
You can create an Optim directory connection manually in the connection manager before the Optim directory is created with the Optim Configuration program. The Optim directory connection contains the connection information for the Optim directory and the Java Database Connectivity (JDBC) driver for the Optim directory database.
You must use a manager user account with admin access to access the connection manager.
The connection manager must have a JDBC driver for the Optim directory database. If the connection manager does not have the correct JDBC driver, you must have the JDBC driver to upload to the connection manager. Upload the JDBC driver when you create the Optim directory connection.
You must also have the JDBC connection properties that the connection manager can use to connect to the Optim directory database. The connection properties can include the following database properties:
To create an Optim directory connection in the connection manager:
When you create an Optim directory with the Optim Configuration program, an Optim directory connection is created in the connection manager. After you create an Optim directory, associate the Optim directory connection with the Java Database Connectivity (JDBC) driver for the Optim directory. You can use the Optim directory connection only after the Optim directory connection is associated with a JDBC driver.
You must use a manager user account with admin access to access the connection manager.
The connection manager must have a JDBC driver for the Optim directory database. If the connection manager does not have the correct JDBC driver, you must have the JDBC driver to upload to the connection manager. Upload the JDBC driver when you edit the Optim directory connection.
You must also have the JDBC connection properties that the connection manager can use to connect to the Optim directory database. The connection properties can include the following database properties:
To edit an Optim directory connection in the connection manager:
The server is the component that processes service requests made from other components. Before the server can accept service requests, you must configure the server for your environment. The process through which you configure the server depends on the operating system on which the server is installed.
The server is the component that processes service requests that are made from other components. After the server is installed, configure the server to accept service requests from the manager or the service interface.
Before you configure the server:
To configure the server on a Microsoft Windows computer:
After you add or edit a data store alias to an Optim directory, you must update the data store alias information on each server. To update data store alias information, merge the connection settings from the current user account with the connection settings on the server.
To update data store alias information for a server on a Microsoft Windows computer:
Configuration files and shell scripts are installed with the executable files when you install the server in a supported Linux or UNIX environment. These objects establish defaults for the server and must be customized to reflect your network environment. Modify these files with a text editor such as vi or emacs.
Configuration files are ASCII text files and are installed in the /etc directory that is subordinate to the PSTHOME directory. PSTHOME is an environment variable, set during installation, that points to the directory in which the server is installed.
The configuration file names for the server are:
The appropriate Configuration file is loaded and validated when pr0svce or the command line utility starts up. You can also use pr0svce -v to validate pstserv.cfg or pr0cmnd -v to validate pstlocal.cfg.
To reload the configuration file for prosvce while it is running, use pr0svce -u from a console under the user account for the daemon (or use pr0svce -u userid from root). After all clients have logged off, the file is read, reloaded, and validated. A console message and system log verify the file has been loaded.
The installed shell scripts are:
The pstserv configuration file is used to configure the system for running pr0svce, the server daemon. An example of pstserv.cfg is in the /etc subdirectory to the PSTHOME directory.
The pstserv.cfg file contains the parameters that are used for running pr0svce. Each parameter in the file is accompanied by comments that explain how to set the parameter. Use the comments to set the parameters to the correct values.
Unless a command line process is directed to a server, the process is executed locally and the settings in pstserv.cfg do not apply. Use the pstlocal.cfg configuration file to provide settings for these local processes. An example of pstlocal.cfg is in the /etc subdirectory to the PSTHOME directory.
The pstlocal.cfg file contains the parameters that are used for running local processes. Each parameter in the file is accompanied by comments that explain how to set the parameter. Use the comments to set the parameters to the correct values.
This file is a script to include in a user .profile or .login script to define the operating environment for the server. The rtsetenv script sets up the server daemon or command-line environment on login. A sample is in the PSTHOME directory.
The following parameters are required:
PSTHOME=/opt/IBM/InfoSphere/Optim
The rtserver script contains commands that control the server process. You must change the script if the server is installed in a directory other than the default directory, /opt/IBM/InfoSphere/Optim. You must also change the script if the server is run under a user account other than root.
The rtserver shell script is in the /sbin directory that is subordinate to the Optim installation directory. To modify the environment variables that specify the server directory and the user account, edit the following places in the script:
rtserver arguments define the operation to be performed, as follows.
The rt4s shell script is used to start or stop the server from init(1) processing, and must be run as part of the system boot procedure. You must change the rt4s shell script if the server is installed in a directory other than the default directory, /opt/IBM/InfoSphere/Optim/rt. You must also change the rt4s shell script if the server is run under a user account other than root.
To modify the environment variables that specify the server directory and the user account, edit the following places in the script:
A symbolic link allows a file name in one directory to point to a file in another directory.
To start and shut down the server as part of init processing, you must create symbolic links to the rt4s script in the following directories:
The location of the rc2.d and rc1.d directories is platformspecific:
Use the ln command to create symbolic links, as follows: ln -s actualfile linkname.
In this case, specify rt4s.
In this case, point links named S99RT4S and K07RT4S to rt4s.
To start and shut down the server during Solaris or Linux init processing, create symbolic links to the rt4s script in directories /etc/rc2.d and /etc/rc1.d.
ln -s /opt/IBM/InfoSphere/Optim/rt/sbin/rt4s /etc/rc2.d/S99rt4s
ln -s /opt/IBM/InfoSphere/Optim/rt/sbin/rt4s /etc/rc1.d/K07rt4s
To start and shut down the server during HP-UX init processing, create symbolic links to the rt4s script in directories /sbin/rc2.d and /sbin/rc1.d.
ln -s /opt/IBM/InfoSphere/Optim/rt/sbin/rt4s /sbin/rc2.d/S99rt4s
ln -s /opt/IBM/InfoSphere/Optim/rt/sbin/rt4s /sbin/rc1.d/K07rt4s
To start and shut down the server during AIX init processing, create symbolic links to the rt4s script in directories /etc/rc.d/rc2.d and /etc/rc.d/rc1.d.
ln -s /opt/IBM/InfoSphere/Optim/rt/sbin/rt4s /etc/rc.d/rc2.d/S99rt4s
ln -s /opt/IBM/InfoSphere/Optim/rt/sbin/rt4s /etc/rc.d/rc1.d/K07rt4s
The first time that you run the designer, you must connect to an Optim directory, and you must set the location of a connection manager in Preferences. If runtime services are installed in a location other than the default location, you must also set the local server location in Preferences.
For more detailed information about how to configure the designer, see the designer information.
If a test- or production-level service fails, or if there are issues with a component, review the log information to troubleshoot the problem.
If a service fails, review the server log first. The server log is available from the manager under Service Monitoring. Select the service instance that failed and click Outputs to view the log.
Because the manager, the connection manager, and the service interface are Java EE applications that run on an application server, all log messages are in the application server log. For example, for WebSphere Application Server Community Edition, the application server log is in wascefolder/var/log/server.log, where wascefolder is the folder in which WebSphere Application Server Community Edition is installed. For example, the default location of the log on a Microsoft Windows computer is C:\IBM\InfoSphere\Optim\shared\WebSphere\AppServerCommunityEdition\var\log\server.log.
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:
For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:
The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:
Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.
The licensed program described in this information and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or any equivalent agreement between us.
Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.
Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.
All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.
All IBM prices shown are IBM's suggested retail prices, are current and are subject to change without notice. Dealer prices may vary.
This information is for planning purposes only. The information herein is subject to change before the products described become available.
This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs.
Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows:
© (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. © Copyright IBM Corp. _enter the year or years_. All rights reserved.
If you are viewing this information in softcopy, the photographs and color illustrations may not appear.
IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.
Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.