IBM BPM, V8.0.1, All platforms > Install IBM BPM > IBM BPM Advanced: Process Server > Install IBM BPM Advanced: Process Server > On Windows > Network deployment environment > Configure profiles and create an ND environment > Create an ND environment > Use the administrative console > Configure components > Configure optional components > Configure Business Process Choreographer

Use the administrative console's deployment environment wizard to configure Business Process Choreographer

Using the administrative console's deployment environment wizard, you can create a pattern-based configuration that includes Business Process Choreographer. If the Business Process Choreographer configuration has its own database, the configuration can be suitable for a production system.

You have performed Plan to use the administrative console's deployment environment wizard.


Procedure

  1. Start the deployment environment wizard. In the administrative console click Servers > Deployment Environments > New. As you enter other configuration parameters, make sure that you enter the values that you planned in Plan to use the administrative console's deployment environment wizard:

    1. You can base the Business Process Choreographer configuration on any of the following patterns:

    2. On the security page, you can set the user name and password that will be used as the authentication alias for Business Process Choreographer, which is identified as component WBI_BPC.

    3. On System REST Service Endpoints page, you can specify the host name and port for your REST endpoints, for example for a web server that hosts the web modules. Use this page to configure service endpoints for Representational State Transfer (REST) system interfaces. If you leave the host and port fields empty, the values default to those of a cluster member host and its HTTP port. For a load-balanced environment, you will have to change the default values to the virtual host name and port of your environment.

    4. On the database page, if you want to use separate databases for Business Process Choreographer, the Business Process Choreographer Explorer, or the Business Process Choreographer messaging engine, change the default data sources from the default values to the values that you planned. If you want to use custom table spaces, do not select the option to have the default tables automatically created in the database.

    5. On the Business Process Choreographer page, specify the context roots, security parameters, and mail session parameters that you planned for this configuration.

  2. If you selected the option to have the default tables automatically created in the database, make sure that the empty database exists. Business Process Choreographer will create the database schema (using the system default table spaces and using your schema name if you provided one) in the database the first time that it accesses the database.

  3. If you did not select the option to have the default tables automatically created in the database, completely prepare the database before you start Business Process Choreographer. Perform the following actions:

    1. If your database does not already exist, create it.

    2. If you want to use custom table spaces use the DbDesignGenerator command to re-generate the necessary SQL scripts.

      If you already used a database design file, make sure that you use the same file again. If you did not use a database design file, take care to enter the identical values in the DbDesignGenerator tool entered in the deployment environment wizard to create a database design file and then generate the SQL scripts.

      For more information about using the database design tool, refer to the following:

    3. Perform Use a generated script to create the database schema for Business Process Choreographer.

  4. If you specified a separate database for Business Process Choreographer messaging engine, make sure that the database exists.

    • If you want to use the Create tables option to have the messaging engine create the default schema the first time that it uses the database, grant the database user ID the rights to create tables and views in the schema that you planned to use.
    • Otherwise, if you will not use the Create tables option, create the tables before the default messaging provider tries to access the database. You can use the sibDDLGenerator utility that is in the bin subdirectory of your INSTALL_ROOT directory to generate a DDL file that can be used to create the tables.

  5. For each node where you want to configure Business Process Choreographer, make sure that the environment variables for the JDBC drivers are set. On a cluster, you must perform this for every node that hosts a cluster member.

    1. Click Environment > WebSphere variables, for Scope, select the node where Business Process Choreographer will be configured.

    2. Select the environment variable for your JDBC provider:

      • For DB2 on z/OS , select DB2UNIVERSAL_JDBC_DRIVER_PATH.

      • For DB2 on Linux, UNIX, or Windows, select DB2_JCC_DRIVER_PATH.

      • For DB2 on z/OS, select DB2UNIVERSAL_JDBC_DRIVER_PATH.

      • For Microsoft SQL Server using the Microsoft SQL Server JDBC Driver, select MICROSOFT_JDBC_DRIVER_PATH.

      • For Oracle, select ORACLE_JDBC_DRIVER_PATH.

    3. Set the environment variable to point to the location of the JDBC driver's JAR file, or files.

  6. Activate Business Process Choreographer: Perform Activating Business Process Choreographer.

  7. Optional: Verify that the basic Business Process Choreographer configuration works: Perform Verifying that Business Process Choreographer works.

  8. Optional: Use the administrative console to change settings for the Human Task Manager:

    • If you want to change any of the Human Task Manager settings for the escalation emails, such as the sender address or the URL prefix for the Business Process Choreographer Explorer, click either Servers > Clusters > WebSphere application server clusters > cluster_name or Servers > Server Types > WebSphere application servers > server_name, then on the Configuration tab, in the Business Integration section, expand Business Process Choreographer, and click Human Task Manager, and make your changes.

    • If you want to change the email server address, port number, the user ID, or password for the email server, click Resources > Mail > Mail sessions, select Cell scope, then click HTM mail session_ suffix, where suffix is either node_name_ server_name or cluster_name, depending on where Business Process Choreographer is configured. Make your changes.

  9. If you configured Business Process Choreographer in a ND environment:

    1. If you will use the Business Process Choreographer Explorer, Business Process Archive Manager, the Business Space, or a client that uses the Representational State Transfer (REST) API, you must change the default context roots for the REST API so that they are unique for each combination of host name and port. To set the context roots perform the following:

      1. To set the context roots for the Business Flow Manager, click Applications > Application Types > WebSphere enterprise applications then application_ suffix > Context Root for Web Modules, where application is BPEContainer for a Business Process Choreographer configuration or BPArchiveMgr for a Business Process Archive Manager configuration, and suffix is either node_name_ server_name or the cluster_name where Business Process Choreographer or Business Process Archive Manager is configured. Then make sure that the context roots for the following web modules and are correct and unique.

        • BFMIF_ scopeWeb
        • BFMJAXWSAPI
        • BFMRESTAPI

      2. To set the context roots for the Human Task Manager, click Applications > Application Types > WebSphere enterprise applications then application_ suffix > Context Root for Web Modules, where application is TaskContainer for a Business Process Choreographer configuration or TaskArchiveMgr for a Business Process Archive Manager configuration, and suffix is either node_name_ server_name or the cluster_name where Business Process Choreographer is configured. Then make sure that the context roots for the following web modules and are correct and unique.

        • HTMIF_ scopeWeb
        • HTMJAXWSAPI
        • HTMRESTAPI

      3. To change the REST URLs that the Business Process Choreographer Explorer uses:

        1. Click Servers > Clusters > WebSphere application server clusters > cluster_name or Servers > Server Types > WebSphere application servers > server_name . On the Configuration tab, in the Business Integration section, expand Business Process Choreographer and click Business Process Choreographer Explorer. Update the Business Flow Manager and Human Task Manager REST API URLs.
        2. Update the endpoints in config-rest.xml using a command similar to the following example, which uses PS.AppTarget as the cluster name: 
          wsadmin>AdminTask.updateRESTServiceProvider(['-clusterName',  'PS.AppTarget', '-appName', 'BPEContainer_PS.AppTarget', '-webModuleName','bfmrestapi.war', '-contextRoot', '/rest/bpm/bfmPS2/'])

wsadmin>AdminTask.updateRESTServiceProvider(['-clusterName',  'PS.AppTarget', '-appName', 'TaskContainer_PS.AppTarget', '-webModuleName','taskrestapi.war', '-contextRoot', '/rest /bpm/htmPS2/'])
        .

    2. If you changed any of the context roots for the Business Flow Manager or Human Task Manager you must also modify the corresponding endpoints:

      1. If you use the Business Process Choreographer Explorer or Business Process Archive Explorer: Change the REST endpoint to match the new context roots by clicking either Servers > Clusters > WebSphere application server clusters > cluster_name or Servers > Server Types > WebSphere application servers > server_name, then on the Configuration tab, in the Business Integration section, expand Business Process Choreographer, and click Business Process Choreographer Explorer, select the BPCExplorer_ scope or BPCArchiveExplorer_ scope instance that you want to modify, and set the new value.

        For example, if the context root for the Business Flow Manager REST API is /rest/bpm/bfm then the full URL might be something like http://system7.mycompany.com:9080/rest/bpm/bfm.

        If you mapped the modules to an HTTP server, proxy server, IP sprayer, load balancer, or similar server, the URL should be based on the hostname and port number for that server.

      2. If you use the Business Space: Change the REST endpoints to match the new context roots by clicking either Servers > Clusters > WebSphere application server clusters > cluster_name or Servers > Server Types > WebSphere application servers > server_name, then on the Configuration tab, in the Business Integration section, expand Business Process Choreographer, and either Business Flow Manager or Human Task Manager, then under Additional Properties click REST Service Endpoint, and set the new value.

        If you mapped the modules to an HTTP server, proxy server, IP sprayer, load balancer, or similar server, the URL should be based on the hostname and port number for that server.

  10. Optional: Update your virtual host configuration. By default, the web modules of the Business Process Choreographer applications are configured for the default_host virtual host. Verify that the ports associated with the host alias are correct. You might need to add host aliases for the host names and ports of additional cluster members or for the web server that is used. For more details about virtual hosts, refer to Virtual hosts.
  11. Depending on the type of people directory provider that you use for people assignment, you might need to configure it:

  12. If you configured VMM, and you want to use people substitution, perform Configure people substitution.

  13. If you want to use group work items, use the administrative console to enable them. Click either Servers > Clusters > WebSphere application server clusters > cluster_name or Servers > Server Types > WebSphere application servers > server_name, then on the Configuration tab, in the Business Integration section, expand Business Process Choreographer, and click Human Task Manager, then select Enable group work items.
  14. If you want to configure a remote Business Process Choreographer client that uses the Process Server client, perform, Configure a remote client application.

  15. If you have WebSphere application security enabled and you have a long-running process that calls a remote EJB method, make sure that your Common Secure Interoperability Version 2 (CSIv2) inbound authentication configuration has CSIv2 identity assertion enabled. For more information about this, refer to Configure Common Secure Interoperability Version 2 inbound communications.

  16. If you require high security, change the default user IDs and passwords for the XA recovery authentication alias that were created for you. An additional XA recovery alias is created for both of the Business Process Choreographer data sources.

    1. In the administrative console, click Security > Global security then in the Authentication section, expand Java Authentication and Authorization Service , click J2C authentication data.
    2. Locate the new XA recovery aliases, which are based on the name of the standard alias with the postfix "_XAR" appended.

      For example, BPCDB_Test.AppTarget_Auth_Alias_XAR and BPCME_01_Auth_Alias_XAR.

    3. By default, the user ID and password for the XA recovery alias are the same ones used for the Business Process Choreographer database user. If that is not acceptable for your security requirements, change the XA recovery alias user IDs and passwords. The database identity for the XA recovery authentication alias on a data source must have authorization to do XA recovery. Depending on the authorization schema for your installation, this level of authorization might be different from the level of authorization that the identity needs to access database tables for an application.


Results

Business Process Choreographer is configured for the deployment environment that you selected.

Configure Business Process Choreographer


Related tasks:
Troubleshooting the Business Process Choreographer configuration