Creating the Standard Process Server deployment environment

Create a Process Server deployment environment to run processes and that are deployed from the Process Center. You can create more than one deployment environments in the same cell using the Deployment Environment wizard.

Before you begin

Ensure that you have completed the following tasks:
  • Installed the product
  • Created the deployment manager profile and the associated nodes
  • Ensure that the database specified in the Database Configuration panel of the Deployment Environment wizard is 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 Troubleshooting > Logs and trace > deployment_manager_name > Change log detail levels > Runtime, add com.ibm.bpm.config.*=all to the Change log detail levels text area, and save the changes.
Note: You must have Process Server installed to install a Process Server-based deployment environment. If you have a Process Center installed, you need to start the IBM Installation Manager and modify your installation to use the Business Process Manager Advanced - Process Server Production or Business Process Manager Advanced - Process Server Non-Production feature.

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.

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 BPM Advanced Edition capability cannot be installed on more than one deployment environment in the same cell.

Procedure

Complete the following steps to create the deployment environment.

  1. From the administrative console, navigate to the Deployment Environments page by clicking Servers > Deployment Environments.
  2. 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.
    1. Enter a unique name for the deployment environment in the Deployment environment name field.
    2. 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.
    3. Enter a password for the deployment environment administrator in the Password field.
    4. Reconfirm the password in the Confirm password field.
    5. Optional: In the Virtual host list, select a virtual host to map to all web modules of the IBM BPM applications in the deployment environment. The default selection is (none).
  3. From the IBM BPM Deployment Environment Type section, select Standard Process Server. Features represent the runtime processing capabilities of your deployment environment.
  4. 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.
  5. 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.

    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.

  6. 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.

  7. 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.

  8. On the Configure Process Server page, set the values for the Process Center configuration and click Next.
    • 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 - development, test, staging, or production. Load testing might be done on a test server, while a staging environment type might be used as a temporary location to host changes before putting those changes into production. You might specify Staging as the environment type if the Process Server you are configuring, will be accessed and used to review content and new functionality.

      There are four types of environments available for selection:

      Development
      Select Development if the server will serve in a development capacity.
      Test
      Select Test if the server you are configuring will be used as a testing environment.
      Staging
      Select Staging if the server will serve as a staging platform to be used as a preproduction server.
      Production
      Select Production if the server will serve in a production capacity.
    • 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.
      Note: Ensure that you specify the host name instead of localhost for the server name when you configure the Process Server. This is required when you are using the Process Designer remotely.
    • 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.

    • Confirm password

      Type to confirm the password for the user.

  9. 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 database specified in this panel must already exist. Deployment environment configuration never creates a database. For more information, see the section about creating databases.
    • Shared parameters
      • User name: Type the user name to connect to the database.
      • Password: Type the password for the user name.
      • Confirm password: Type to confirm the password for the user name.
      • Server: Type a server name where the database subsystem is located.
      • Port: Type the port number to connect to the database subsystem.
      • Database connection location: Type the database connection location name.
      • Storage group: Type the storage group name.
      • Volume Catalog: Type the volume catalog name.
      • Buffer pool of 4k size: Type a name for the buffer pool with size 4k.
      • Index buffer pool : Type the index buffer pool name.
      • LOB buffer pool : Type the LOB buffer pool name.
      • Buffer pool of 8k size: Type a name for the buffer pool with size 8k.
      • Buffer pool of 16k size: Type a name for the buffer pool with size 16k.
      • Buffer pool of 32k size: Type a name for the buffer pool with size 32k.
    • Common database
      • Name: Type a name for the common database which is used for CommonDB components, Business Space, Business Process Choreographer, and Messaging.
      • Schema name: Type the schema name for the common database.
    • Process database
      • Name: Type a name for the Process Center database.
      • Schema name: Type the schema name for the Process database.
    • Performance Data Warehouse database
      • Name: Type a name for the Performance Data Warehouse database.
      • Schema name: Type the schema name for the Performance Data Warehouse database.
    • Select the databases that you want to separate from the Common database.
      • Messaging: Select this option to create a separate messaging engine database.
        • Name: Type a name for the messaging engine database.
        • Schema name: Type the schema name for the messaging engine database.
    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.
    For a production environment, you should set the same values for User name and Schema name and you should clear Create Tables. For a production environment, create the required schemas manually and use the SQL files generated to create the tables. When you create a 3-cluster Process Server using the Deployment Environment wizard the process will take a lot of time to complete. Perform one of the following steps to create the 3-cluster Process Server:
    • Increase the transaction timeout value using the Deployment Manager and re-create the deployment environment.
    • Do not create tables during the Deployment Environment creation. After creating the environment create the databases, tables, and then run the bootstrap command.

    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 Servers > Deployment Environments > Deployment environment name > Deployment Environment Configuration > Additional Properties > Deferred Configuration.
  10. Verify that the information on the Summary page is correct and perform the following substeps:
    1. Optional: If you want to exit without generating the configuration, click Cancel.
    2. Optional: If you want to save the environment configuration to configure a similar Deployment Environment, click Export for Scripting.
    3. 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.
  11. 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 Environment > Virtual hosts > default_host > Host Aliases 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.