Create the Process Server deployment environment using a pattern

IBM BPM, V8.0.1, All platforms > Install IBM BPM > IBM BPM Advanced for z/OS: Process Server > Configure IBM BPM Advanced for z/OS: Process Server > Completing the ND configuration > Create the deployment environment > Configure servers, server clusters, and product components > Set up deployment environments > Create deployment environments > Create deployment environments using the Deployment Environment configuration wizard
Create the Process Server deployment environment using a pattern

After determining the pattern on which to base your ND configuration, use the Deployment Environment wizard to create the IBM BPM Advanced Process Server deployment environment that is based on the pattern.

Tip: An alternative to using a pattern to create the deployment environment is using an imported design. See Importing deployment environment definitions based on design documents using the administrative console
When security and role-based authorization are enabled, you must log in to the administrative console as an administrator or configurator to perform this task.
You should have planned the patterns and features that you want to configure. See Plan an ND environment.
It is assumed that you have installed the product and that you have created the dmgr profile and the associated nodes.
Additionally, one of the steps in the Deployment Environment Configuration wizard includes importing a database design document (which is also known as a database design file). The database design document defines the database configuration for the selected deployment environment features. IBM BPM provides a response-driven database design tool that creates a database design document based on user inputs. The database design tool also provides an option to create the database scripts that can be used to create one or more databases for the IBM BPM. The database design document can be used by the IBM BPM Deployment Environment wizard to configure the databases used in the deployment environment. For more information about how you can use the database design tool to generate the database design document and database scripts, see Generate a design file and database scripts for the database objects.

This task describes the procedure for creating a deployment environment that is based on a specific pattern and uses the Deployment Environment Configuration wizard.
If you make an error while you are working in the wizard, you can go back by clicking Back.

Procedure

From the administrative console, go to the Deployment Environments page.
For example, click Servers > Deployment Environments.
Launch the Deployment Environment Configuration wizard by clicking New on the Deployment Environments page.

The option...
Create a deployment environment based on a pattern

...is selected. This is the default pattern.
A pattern provides you with a template for the deployment environment that you are creating.
The system default pattern is...
Remote messaging and remote support

For information on the types of patterns provided with IBM BPM, see Topology types and deployment environment patterns.
Enter a unique name for the deployment environment in the Deployment environment name field.
Optional: To view all of the configuration steps in the wizard, select Detailed: Show all steps.
If you choose Fast path: Show only needed steps the wizard displays only those pages that do not have assigned default values. Choose Fast path: Show only needed steps only if you are agreeable to accepting the system-provided default values for the deployment environment configuration. Also note that if you want to specify a starting port number for your cluster groups, as described in step 7, you must select Detailed: Show all steps.
This topic assumes that you have chosen Detailed: Show all steps
Click Next to display the Deployment Environment Features page.

On the Deployment Environment Features page, select the feature for the deployment environment and click Next to either view a list of compatible features, or to view a list of deployment environment patterns.
The list of available features is based on the dmgr profile. If your dmgr profile has been augmented to include other products alongside IBM BPM (for example, IBM Business Monitor, then the Deployment Environment Features page also lists these features.
If you have configured a profile for IBM BPM, then the page includes the following details:

For IBM BPM Advanced:

WESB, for WebSphere Enterprise Service Bus, which provides a deployment environment that supports mediations.
BPMAPS, for an IBM BPM Advanced, Process Server dmgr profile, which provides a Process Server deployment environment that supports mediations, business processes, human tasks, Business Space functions, and business rules.

The default value for the deployment environment feature matches the runtime capabilities of your dmgr.

On the Select compatible deployment environment features page, select additional features as necessary and click Next to view the list of patterns associated with your primary and ancillary feature selections.
The page is displayed only if the dmgr has been augmented with other BPM features, such as IBM Business Monitor.

On the page...
Select the deployment environment pattern
...select the pattern for the selected deployment environment, then click Next to display the Select Nodes page.
The list of patterns that display is dynamic. This list is activated by, and dependent on, the following environment conditions:

The platform on which you have installed the software
The selections made on pages...
Select the deployment environment features
Select compatible deployment environment features

For a detailed description of the relationship of patterns to features, see Topology patterns and supported product features.
Optional: On the page...
Select Nodes
...select the nodes to be included in the deployment environment then click Next to display the Clusters page.
Select nodes that have the required capabilities for the environment you selected in step 3.
For example, if you selected BPMSPC as your Deployment Environment type, the nodes selected should address the capabilities of that environment type.
Select at least one node for the deployment environment. For high-availability and failover environments, select at least two nodes. For scalability, select all nodes.
To include a node, select the check box next to the node name. Use Node Mapping to map the selected node to another node name.
Optional: On the Clusters page, assign the required number of cluster members and the initial port to use on each node for each cluster type (Application Deployment Target, Messaging Infrastructure and Supporting Infrastructure) of the deployment environment.
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.
After assigning cluster members, you can click Next to display the Cluster naming pages for each cluster type of the deployment environment. The Cluster naming sub-steps that display will vary depending on the deployment environment pattern selected.
You can specify the initial port using the Specify the port number for the first cluster group (Optional): text box. 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 first cluster member and subsequent cluster groups would be assigned ports after increasing the port value by 20.
For example, if the port number for the first cluster group is 2000, the port numbers of the cluster members would be 2000, 2001, 2002, and so on. The port number of the second cluster group would be 2020 and the port numbers for the members of the second cluster group would be 2020, 2021, 2022, and so on. The port number of the third cluster group would be 2040.
If there is already a node on that physical system then there may be port conflicts and these would need to be resolved manually by changing the port values.
The system generates default values for cluster names and cluster member names. The system also generates default values for the cluster short name and cluster member short name.
If you do not want to customize cluster names or cluster member names, you can use the wizard navigation pane to go directly to the REST Services page in a following step.
Each substep page is structured in the same fashion, and is described in Customize the cluster names and cluster member names.

Optional: Customize the cluster names and cluster member names.
Use the Cluster Naming page to customize cluster names or cluster member names for the cluster type. You can also modify cluster short names and cluster member short names. There is one substep page for each cluster type in the pattern that you have selected.
For example, if you selected a Remote messaging and remote support pattern, there are 3 sub-steps, one for each type of cluster (Application Deployment Target, Messaging Infrastructure and Supporting Infrastructure) in that pattern.
The information on each substep page is as follows:

Cluster

A read-only field specifying the functional role of the cluster.
The value varies depending on the cluster type, as follows:

Application Deployment Target
Messaging Infrastructure
Supporting Infrastructure
Web Application Infrastructure
See Topology types and deployment environment patterns

Cluster Name

Contains the system-generated default value for the cluster name.
The default values are based on a naming convention of <Deployment Environment Name>.<Cluster type name>, where cluster type name is one of the following values:

AppTarget
For clusters performing the role of application deployment target
Messaging
For clusters performing the role of messaging infrastructure
Support
For clusters performing the role of supporting infrastructure
Web
For clusters performing the role of supporting web applications.
This cluster type name applies for BPM configurations in which WebSphere Business Monitor is the primary feature / product.

Cluster Short Name

You can leave this field blank or enter a short name of your choosing.
Cluster short names cannot exceed 8 characters in length, and must be unique so as to avoid naming collisions. At creation time, the system checks against the following rules to ensure the validity of the cluster short name:

Must be one to eight characters in length
Must contain only alphanumeric or national language characters
Cannot start with a number
Must be unique in the cell
Cannot be the same as the value specified on the ClusterTransitionName custom property of any non-clustered server

Cluster Member Name

Accept the system-generated default value or specify a name of your choosing.
The default value for the cluster member name is based on the following naming convention: <cluster name>.<node name>.<node number sequence> .
The number of cluster member names that display in the table match the number of cluster members entered for the cluster type column and node row on the Clusters page. See the preceding step for the Clusters page.

Cluster Member Short Name

Accept the system-generated default value or specify name of your choosing.
The system-generated value for cluster member short name is based on a naming convention of <deployment environment name>[0:5]<cluster type name>.
The cluster member short name is limited to 7 characters and MUST BE UNIQUE.
If the cluster member short name is not unique, the system appends a unique number to it.
As an example, for a deployment environment named DEPENV, the system-generated short name for the application target cluster member is DEPENVAT.
The option for cluster member short name displays when the following configuration conditions exist:

If any one known node in the cell is on a z/OS platform, then the cluster member short name displays. The node metadata should support the platform on which the node resides.
If the Deployment Manager resides on a z/OS platform.

On the REST Services page, configure service endpoints for Representational State Transfer (REST) API.
If you want widgets to be available in Business Space, configure the REST service endpoints for those widgets.

Configure a full URL path for all REST services by selecting either https:// or http:// from the Protocol list.
Enter a name in the field...
Host Name or Virtual Host in a Load-Balanced Environment

In the Port field, enter the port that a client needs to communicate with the server or cluster.
In the table of REST services, to modify the description of the REST service endpoint, overtype the entry in the Description field. The other fields are read-only.
Click Next to go to the Import the database configuration page.

On the Import the database configuration page, click Browse to go the database design document, or enter the path to the database design document. to go to the Data sources page.

For DB2 for z/OS databases, you must import a database design document. For other database types, this step is optional.
The database design document that you import must be available on the local file system from which the administrative console is being accessed. If you ran the database design tool from your IBM BPM for z/OS installation in order to create the database design document, use FTP to transfer the file from the UNIX System Services environment to the local file system, and then import the file.

The design document can be based on a database design created using the database design tool.
The database design document that you import for the deployment environment does not change the commonDB created at Profile Creation time.
Required: On the Database page, configure the database parameters for data sources of the deployment environment, then click Next to go to the Security page.

The database specified in this panel must already exist. Deployment environment configuration never creates a new database.
For DB2 and SQL Server databases, IBM Process Server and Performance Data Warehouse should not use the same database as the rest of the components. However, if you are using an Oracle database, IBM Process Server and IBM Performance Data Warehouse can use the same database instance, but should use different users.
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.
If you imported a database design document, the information on the Database page reflects the data source configuration as it exists in the database design document that you imported.
Whether or not this step displays for a fast path deployment environment configuration is conditional. This step displays for a fast path deployment environment configuration if more than one database has been defined.
This step always displays if you are using DB2 for z/OS or an Oracle database provider.

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.

Oracle database considerations:

Verify that the username and schema name are exactly the same. The user specified should exist in the database before generating the environment.

SQL Server considerations:

Verify that the username and schema exist before the configuration is done. The schema value should be the default schema for the user chosen.
To indicate that users will connect to the databases using Windows credentials, select the individual data source, click Edit, and select Apply Windows authentication.

For a production environment, you should set the same values for User name and Schema name and clear Create tables. For a production environment, create the required schemas manually and use the SQL files generated to create the tables.
You cannot select Create tables for Business Space (the option is unavailable for selection). The SQL files for Business Space need to be run manually. For information on running the SQL manually for Business Space, see Configure Business Space database tables.
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.

DB2 for z/OS: The Create tables option cannot be used if you are using a DB2 for z/OS database provider.
Steps that cannot be completed through the Deployment Environment Configuration wizard, and which need to be completed manually, are listed on the Deferred Configuration page.

On the Security page, configure the authentication aliases WebSphere uses when accessing secure components.
You can change the authentication alias user name and password on this page. These aliases are used to access secure components but do not provide access to data sources.

On the Process Server page, set the values for the Process Server configuration as follows:

Environment name
Enter an environment name of the Process Server.
An environment name is the name by which this server or cluster will be known to a Process Center user.
Environment type
From the pull-down list, select the Environment type for the Process Server you are configuring.
The Environment type refers to how the Process Server is used.
For example, in what capacity will the Process Server be used - production, stage, or test. Load testing might be done on a test server, while a stage environment type might be used as a temporary location to host changes before putting those changes into production. You might specify Stage as the Environment type if the Process Server you are configuring, will be accessed and used to review content and new functionality.
There are three types of environments available for selection:

Production

Select Production if the server will serve in a production capacity.

Stage

Select Stage if the server will serve as a staging platform to be used as a preproduction server.

Test

Select Test if the server you are configuring will be used as a testing environment.

Use server offline
Indicate whether the server you are configuring is an offline server.
An offline server is a Process Server that is not connected to the Process Center.
Offline servers can still be used when deploying snapshots of process applications. However the method for deploying process applications to an offline process server differs from the method for deploying process applications to an online process server.
Protocol
Select either http:// or https:// as the connection protocol to the Process Center.
Host name or virtual host in a load-balanced environment
Type the host or virtual host that this Process Server needs to communicate with Process Center. Use a fully qualified host name. In an environment with a load balancer or proxy server between the Process Server and the Process Center services, make sure that what you designate here matches the URL for accessing the Process Center.
Port
Type the port number of the Process Center. In an environment with a load balancer or proxy server between the Process Server and the Process Center, make sure that what you designate here matches the URL for accessing the Process Center.
User name
Type a valid user name that exists on the Process Center. Process Server will connect to Process Center as this user.
Password
Type the password for the user.

On the Business Process Choreographer page, set parameters for the Business Process Choreographer configuration and then click Next to display the Web application context roots page. On this page you specify the values for:

Security roles
Authentication aliases

Optional: On the Web application context roots page, set the context root for component-based web applications in your deployment environment or accept the system-provided default values for the context roots. Then click Next to display the Summary page.
The Web application context roots page displays for deployment environments using the Remote Messaging, Remote Support, and Web Applications pattern.
The table contains the following control information.

Web Application

The name of the web application.

Context Root

The current value of the context root for the component.
By default, the default context root for the web application applies.
You can change the context roots by typing over the value in the Context Root field.
The Business Space context root is read only and cannot be edited.

Description

The description of the web application context root.

Verify that the information on the Summary page is correct and perform the following substeps:

If you do not want to save the deployment environment configuration, you can click Cancel.
If you want to exit without generating the configuration, click Finish.
To get back to the panel (if you exited without completing), perform the following from the administrative console: Deployment Environments > name of deployment environment > Generate Environment.
To save the deployment environment configuration, click Finish and from within the Messages window, click Save.
Clicking Save saves the deployment environment to the master configuration. If an error occurs during deployment environment generation, the configuration settings are saved to the master configuration.
Check for deferred configuration steps.
Select Deployment Environments > name of deployment environment > Deferred Configuration.
You need to address any existing deferred configuration steps before starting the Deployment Environment.
If you are satisfied with the deployment environment configuration and you have addressed any of the deferred configuration steps, click Finish and Generate Environment to save and complete the configuration of the deployment environment.

Load the database with system information by running the bootstrapProcessServerData.sh command.
This command must be run before starting the Process Center or Process Server cluster members.
Change the server short names to meet z/OS system naming conventions.
You should limit your server short names to seven characters to allow an S or an A to be added to designate servant regions or adjuncts.
To change the server short name for z/OS...

From the administrative console, navigate to Servers > Server Types > WebSphere application servers.
Click the name of the server that you want to change.
Type the new server.short name in the Short Name area.

For example change the existing short name it from BBOS001 to WZ xxZ1 where xx is the prefix of the cell, for example WZT5Z1.
For more information on server naming conventions for z/OS, see the WebSphere Application Server Information Center.

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.
After you have configured an ND environment, if you test the data store connection (for example, in the administrative console, on the page Resources > JDBC > Data sources), you get a message saying that the test connection operation failed with the exception com.ibm.wsspi.runtime.variable.UndefinedVariableException: Undefined Variable WAS_INSTALL_ROOT. 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.
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 used by the new server.

Create deployment environments using the Deployment Environment configuration wizard

Related concepts:
Generate a design file and database scripts for the database objects

Related tasks:
General steps for implementing a deployment environment
Configure deferred configurations for a deployment environment

Related information:

z/OS application server naming conventions
Configure Business Process Choreographer