Create a Workflow Server deployment environment to run processes,
services and modules that are deployed from the Workflow Center. Or, deploy modules either from the command line or from the WebSphere® administrative console. You can create more than one deployment environment in the same cell using the Deployment Environment
wizard.
Important: The deployment environment wizard does not support case management for Db2® for z/OS® databases. If you want to use case management, use the BPMConfig command
to create the deployment environment.
Before you begin
Ensure that you
have completed the following tasks:
- Install the product
- Create the deployment manager profile and the associated nodes
- Ensure that the databases specified in the Database Configuration panel of the
Deployment Environment wizard are already created. The deployment environment
configuration never creates a database. For more information, see the section about creating
databases.
- Make sure that you start all the local and remote nodes that you
want to add in the deployment environment.
- When you create a 3-cluster deployment environment using the Deployment
Environment wizard, the process might take a lot of time
to complete. In that case, you can perform one of the following steps
to create the 3-cluster environment:
- If you are using the Deployment Environment wizard, you can enable
deployment manager trace for details about the deployment creation.
To enable trace for a single run and till the deployment manager restarts,
log in to the administrative console, go to , add
com.ibm.bpm.config.*=all to the Change
log detail levels text area, and save the changes.
Note: You must have Workflow Server installed to install a Workflow Server-based
deployment environment.
Because the procedure for creating
deployment environments using the Deployment Environment wizard
includes steps for selecting patterns and features, you should read
and understand the information about patterns and features documented
in the planning section.
Required security role for this task: When
security and role-based authorization are enabled, you must log in to the administrative console as
a user with Admin Security Manager and Administrator roles to create a deployment environment. You
cannot grant a group the rights to create a deployment environment. You must use users for this
task.
About this task
This
task describes the procedure for creating a deployment environment
that is based on a specific pattern and uses the Deployment
Environment wizard. When you complete the configuration,
the database scripts that you can use to configure the databases are
generated.
Note: A snapshot that requires Advanced capability cannot be installed on
more than one deployment environment in the same cell.
Procedure
Complete the following steps to create the deployment environment.
- From the administrative console, navigate to the Deployment
Environments page by clicking .
- Launch the Deployment Environment wizard by
clicking New on the Deployment Environments page. The
Create new deployment environment page is displayed.
Note: The database provides isolation of internal groups, such as administrators. If the database is
shared by two deployment environments, one administrators group is shared between them. When such a
situation occurs, both administrators are able to login as administrator for each of the deployment
environment.
- Enter a unique name for the deployment environment in the Deployment
environment name field.
- Enter a user name for the deployment environment administrator in the
Deployment environment administrator user name field.
Note: It is recommended to use a different administrator for each deployment environment and also
the cell administrator.
- Enter a password for the deployment environment administrator in the
Password field.
- Reconfirm the password in the Confirm password field.
-
In the Dmgr's JDBC driver folder field, specify the JDBC driver path for
the deployment manager. This folder must contain the JAR files for the JDBC drivers for your
database.
For DB2®, the default value is ${WAS_INSTALL_ROOT}/jdbcdrivers/DB2. For
Oracle and SQL Server, there is no default and you must specify a value.
-
In the Context root prefix field, you can either accept the default
blank (empty) value or you can specify a context root prefix for all web modules in this
environment. If set, the context root prefix must start with a forward slash character (/).
- Optional: In the Virtual host list, select a
virtual host to map to all web modules of the Business Automation Workflow applications in the
deployment environment. The default selection is (none).
-
From the Business Automation Workflow Deployment Environment
Type section, select Advanced Workflow Server. Features
represent the runtime processing capabilities of your deployment environment.
- From the Select the deployment environment
pattern section, select a pattern for the deployment environment and click
Next to display the Select Nodes page. The available
patterns are:
- Single Cluster: The application deployment target includes the messaging
infrastructure and supporting applications.
- Application, Remote Messaging, Remote Support: A separate cluster each
for application deployment, remote messaging, and remote support.
- On the Select Nodes page, select the nodes that
you want to include in this deployment environment, then click Next to
display the Define Clusters page.
Select nodes that have the required capabilities for the environment you selected on the IBM® BPM Deployment Environment Features section.
In the JDBC Driver Path field for each node, specify the JDBC driver path for the deployment manager. This folder must contain the JAR files for the JDBC drivers for your database. For DB2, the default value is ${WAS_INSTALL_ROOT}/jdbcdrivers/DB2.
For Oracle and SQL Server, there is no default and you must specify a value.
Select at least one node for the deployment environment. For high-availability and failover
environments, select at least two nodes. For scalability, you can add more nodes.
- On the Define Clusters page, assign the
required number of clusters for each node and click Next to display the
Customize Cluster Name and Ports page.
By default one cluster member is assigned on each node for each function. You change the number
by replacing the number in each column. If you are unfamiliar with the different cluster roles and
functions provided by each type of cluster, see Topology types and deployment environment
patterns.
A 0 (zero) value for a node means that the node does not contribute to the selected function,
based on features that you have selected.
- On the Customize Cluster Name and Ports
page, customize the cluster names or cluster member names for the cluster type. You can use the
default values provided, or customize the cluster details, and click
Next.
Note: You can specify the starting port for the cluster members. The system generates default values
for cluster member names and the starting port.
Ensure that the starting port numbers you specify
are at least 20 ports apart. Port numbers are reserved and assigned to each node for the cluster
members using the port number that is specified. If you specify an initial port when you create the
deployment environment, that same initial port specified would be assigned to the cluster member.
For example, if the port number for the first cluster member is 2000, it would use the port numbers
2000, 2001, 2002, and so on. The port number of the second cluster member would be 2020 and the port
numbers would be 2020, 2021, 2022, and so on. The port number of the third cluster member would be
2040.
If there is already a node on that physical system then there may be port conflicts and
these must be resolved manually by changing the port values.
If you use additional servers
with unique ports, WebSphere Application
Server
does not automatically configure the virtual host for the server. Specifically, WebSphere Application
Server does not automatically
add the host alias ports to a virtual host. However, you can use the administrative console to add a
new host alias for each of the ports that are used by the new server. For more information, see the
WebSphere Application
Server documentation about
configuring virtual hosts.
- Required: On the Configure
Databases page, select DB2 On ZOS, configure the database
parameters for data sources of the deployment environment, click Test
connection, and after the connection succeeds click Next to go to
the Summary page.
On this page, define the database information for the components that are included in this
deployment environment. Where possible, the wizard supplies default information for the parameters,
but change those values to match the values that you defined when you planned the environment.
Important: The databases specified in this panel need to be created by the DB2 z/OS System Administrator.
Attention: The default schema names that are displayed on this page might conflict with
your site naming convention or might conflict with existing schemas. As such, it is likely that you
will need to change the schema name. Pay close attention to the values specified to avoid potential
naming conflicts.
You can edit all key parameters, such as the database name, whether or
not to create tables, the data source runtime user name, and the password for the deployment
environment. You can select which database to use for the given component.
Tip: Steps that cannot be completed through the
Deployment Environment wizard, and which need to be completed manually, are
listed on the Deferred Configuration page. You can view this page after you have created your
deployment environment. To view this administrative console page, click .
- Verify that the information on the Summary
page is correct and perform the following substeps:
- Optional: If you want to exit without generating the configuration, click
Cancel.
- Optional:
If you want to save the environment configuration to configure a similar deployment
environment, click Export for Scripting.
- If you are satisfied with the deployment environment configuration, click
Generate Deployment Environment to save and complete the configuration of the
deployment environment. This will also generate a properties file in the
BPM_Install_Root/logs/config folder on the deployment
manager machine with a timestamp in the file name,
bpmconfig-de_name-timestamp.properties. Save this file for
future reference or for troubleshooting any issues.
- Load the database with system information by running the
bootstrapProcessServerData command.
Important: This command must be run before starting any cluster members.
Results
When the configuration completes, you can examine
the configuration files to view the changes.
What to do next
Either save the changes to the master configuration
or discard them.
Important: If you use
additional servers with unique ports, WebSphere Application
Server
does not automatically configure the virtual host for the server. Specifically, WebSphere Application
Server does not automatically add the host alias ports
to a virtual host. However, you can use the administrative console to add a new host alias for each
of the ports that are used by the new server. To add a host alias, in the administrative console
navigate to and click New. For more information, see the WebSphere Application
Server documentation about configuring virtual
hosts.
Clean
all applicable profile logs or save them in another directory. You
may want to clean or move the logs as they will be appended with the
last configuration. This can make it difficult to view the most current
information.
Tip: After you have
configured a network deployment environment, if you test the connection to the cell-level
jdbc/WPSDB data source (for example, in the administrative console, on the page ), you get a message saying that the test connection operation failed with the
exception com.ibm.wsspi.runtime.variable.UndefinedVariableException: Undefined Variable
variable_name, where variable_name is a variable name
such as WAS_INSTALL_ROOT, DB2_JCC_DRIVER_PATH,
UNIVERSAL_JDBC_DRIVER_PATH or PUREQUERY_PATH. This does not
necessarily indicate that there will be a problem accessing the data source at run time. Ensure that
the location of your JDBC driver files is accessible to every client that must use the data source,
and configure the variable with the full path of that location. Disregard the test connection error
unless you are also experiencing trouble connecting to the data store at run time. For additional
information, see the WebSphere Application
Server documentation about
the test connection service.
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15