Creating the Process Server deployment environment

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

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.
   1. The Create a deployment environment based on a pattern option is selected. Create a deployment environment based on a pattern is the system default and it is the option described in this topic.

      Deployment environment patterns capture commonly used business integration topologies. A pattern provides you with a template for the deployment environment that you are creating.

      Note: Patterns have a direct relationship to the products supported by the configured deployment manager. IBM Business Process Manager supports a specific set of patterns, with the Remote messaging and remote support pattern being the system default. If your deployment manager supports other products in addition to IBM Business Process Manager, additional patterns may apply. Consult product-specific documentation for information on patterns as they apply to the products.
   2. Enter a unique name for the deployment environment in the Deployment environment name field.
   3. 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.

      This topic assumes that you have chosen Detailed: Show all steps

   4. Click Next to display the Deployment Environment Features page.
3. 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. Features represent the runtime processing capabilities of your deployment environment.

   The list of available features on the Deployment Environment Features page is based on the deployment manager profile. If your deployment manager profile has been augmented to include other products alongside IBM Business Process Manager (for example, IBM Business Monitor , then the Deployment Environment Features page also lists these features.

   If you have installed and configured a profile for IBM Business Process Manager, then the Deployment Environment Features page includes the following details:

   • For IBM Business Process Manager Advanced:
     • WESB, for WebSphere® Enterprise Service Bus, which provides a deployment environment that supports mediations.
     • BPMAPS, for an IBM BPM Advanced, Process Server deployment manager profile, which provides a Process Server deployment environment that supports mediations, business processes, human tasks, Business Space functions, and business rules.
     • BPMAPC, for an IBM BPM Advanced, Process Center deployment manager profile, which provides a Process Center 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 deployment manager.

4. 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 feature selections.
   Note: The Select compatible deployment environment features page is displayed only if the deployment manager has been augmented with other business process management (BPM) features, such as IBM Business Monitor.

   For an understanding of the relationship of features and compatible features, see the information on deployment environments in the Planning section.

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

   • The platform on which you have installed the software
   • The selections that you have made on the Select the deployment environment feature page and the Select compatible deployment environment features page.
6. Optional: On the Select Nodes page, select the nodes that you want to include in this deployment environment, then click Next to display the Clusters page.

   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.

   Select nodes that have the required capabilities for the environment you selected on the Deployment Environment Features page. 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.

7. Optional: On the Clusters page, assign the required number of cluster members and the initial port to be used on each node for the cluster members of all cluster types.

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

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

   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.

   1. 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. 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 substeps, 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:

      Field	Description	Value
      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 Supporting Infrastructure Messaging Infrastructure Web Application Infrastructure For information on the functional role provided by each cluster type, see Topology types and deployment environment patterns
      Cluster name	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. Note: This cluster type name applies for BPM configurations in which WebSphere Business Monitor is the primary feature / product.
      Cluster member name	The system-generated default value for the cluster member name. Servers that are a part of a cluster are called cluster members.	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 that you entered for the cluster type column and node row on the Clusters page.

8. On the System REST Service endpoints page, configure service endpoints for Representational State Transfer (REST) application programming interfaces (APIs).

   If you want widgets to be available in Business Space, you must configure the REST service endpoints for those widgets.

   1. Configure a full URL path for all REST services by selecting either https:// or http:// from the Protocol list.
   2. Enter a name in the Host Name or Virtual Host in a Load-Balanced Environment field.
   3. In the Port field, enter the port that a client needs to communicate with the server or cluster.
   4. In the table of REST services, if you want to modify the description of the REST service endpoint, overtype the entry in the Description field. The other fields are read-only.
   5. Click Next to go to the Import the database configuration page.
9. Optional: On the Import the database configuration page, click Browse to go the database design document or enter the path to the database design document and then click Next to go to the Data sources page. If you import a design document, the information from the design document is reflected on the Database page of the wizard. The design document can be based on a database design that you created using the database design tool (DDT), or it can be the supplied design document based on the pattern and feature that you have selected.
   Note: The database design document that you import for the deployment environment does not change the commonDB created at Profile Creation time.
10. On the Database page, configure the database parameters for data sources of the deployment environment, then click Next to go to the Security 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. 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 or if you are using a DB2 for z/OS or an Oracle database provider.

    Important: The database specified in this panel must already exist. Deployment environment configuration never creates a new database.

    Additionally, 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. If you make changes to the data source configuration after importing a database design document, your changes might be incompatible with the DDL generated by the database design tool and the original values.
    CAUTION:
    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.
    SQL Server considerations:

    • Make sure that the username and the schema exist before the configuration is done. The schema value should be the default schema for the user chosen.
    • IBM Process Server and IBM Performance Data Warehouse should not use the same database.
    • If connections to the database will be made by the current Windows user that the server is running under, the SQL Server must have Windows authentication mode or SQL Server and Windows Authentication mode enabled, as specified through Microsoft SQL Server Management Studio.
    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 4-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 4-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.

    Note: 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 Configuring 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.

    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.
11. On the Security page, configure the authentication aliases used 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

12. On the Process Center page, set the values for the Process Center 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.

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

    Some of the components that are part of the deployment environment you are creating contain web applications. The Web Application column can include the following components:

    • Business Space
    • Business Process Choreographer Explorer
    • Business Process Rules Manager

    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.

    Note: The Business Space context root is read only and cannot be edited.

15. Verify that the information on the Summary page is correct and perform the following substeps:
    1. Optional: If you do not want to save the deployment environment configuration, you can click Cancel.
    2. Optional: 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 .

    3. 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 should occur during deployment environment generation, the configuration settings will have been saved to the master configuration.

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

    5. 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.
16. Optional: Load the database with system information by running the bootstrapProcessServerData command. This step is required only if the database is not created during the deployment environment configuration.
    Important: This command must be run before starting any cluster members.
17. Verify the deployment environment was created properly by completing the following steps:
    1. Log off from the administrative console, shut down the deployment manager, and then shut down all of the custom profiles.
    2. Start the custom profiles, start the deployment manager, and then log in to the administrative console.
    3. In the administrative console, start the deployment environment by clicking Servers > Deployment Environments. Select the check box next to the deployment environment and clicking Start.
    4. After 5 to 10 minutes (or longer, depending on the system), refresh the deployment environment page; the Status of the deployment environment changes to started.
    5. Locate the Tables folder for the common database. Check that the tables have been created with the four schemas that you created manually.
    6. Optional: Check that tables have been created with the XXXBE## schema in the Business Process Choreographer database.
    7. In the administrative console, select Applications > Application Types > WebSphere enterprise applications and check that the installed applications started successfully.
    8. Select Resources > JDBC > Data sources and test that the connection of every component that is not related to the message engine (that is, every component that does not include ME in the name) is successful.
18. Complete your Process Portal configuration by performing the following actions:
    1. If you are using a three or four cluster configuration, and you have not yet configured a routing server for Business Space, to ensure that requests for Process Portal are redirected to the correct cluster, perform the actions in one of the following.
       • Configuring IBM HTTP Server for Business Space: .
       • Configuring a WebSphere Application Server proxy server for Business Space: .
       • Mapping Business Space URLs for a reverse proxy server: .
       Tip: The reason why you need a routing server for three and four cluster configurations is because Process Portal uses web components that are distributed across two clusters. If you do not configure a suitable server to redirect requests to the appropriate clusters, the web browser’s same origin policy will prevent Process Portal from working correctly. In a three cluster configuration, Process Portal relies on applications on both the application deployment target cluster and the support cluster. In a four cluster configuration, Process Portal relies on applications on both the application deployment target cluster and the web cluster.
    2. If you want users to be able to access Process Portal using HTTP rather than the Business Space default of HTTPS, perform Designating HTTP or HTTPS settings for Business Space: .
    3. Perform Verifying Process Portal: .