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 Business Process Choreographer configuration page

Describes how to use the administrative console's Business Process Choreographer configuration page to create a configuration on a given server or cluster.

Before you start, complete the following task:

• Configure SCA support for a server or cluster

You must configure the necessary resources and configure Business Process Choreographer before you can run applications that contain BPEL processes or human tasks.

Procedure

1. If you selected the Business Process Choreographer sample configuration option when you created a default profile, the Business Flow Manager, Human Task Manager, and Business Process Choreographer Explorer are already configured.

   You can check if they are configured, by looking in the administrative console for enterprise applications with names that start with:

   • BPCExplorer
   • BPEContainer
   • HTM_PredefinedTasksMsg
   • HTM_PredefinedTasks
   • TaskContainer

   The sample configuration is not suitable for a production system. Because you can only have one Business Process Choreographer or Business Process Choreographer Archive Manager configuration on a deployment target, you must remove the sample configuration, as described in Advanced only: Removing the Business Process Choreographer configuration before you can create a new configuration.

2. If you have an ND environment, use the administrative console to make sure that the Service Component Architecture is configured:

   1. If you want to configure Business Process Choreographer on a server, click Servers > Server Types > WebSphere application servers > server_name, then in the Business Integration section, click Service Component Architecture.

   2. If you want to configure Business Process Choreographer on a cluster, click Servers > Clusters > WebSphere application server clusters > cluster_name, then in the Business Integration section, click Service Component Architecture.

   3. If it is not enabled, select Support the Service Component Architecture components, complete all the configuration settings as appropriate, then click Apply and Save.
3. Create the Business Process Choreographer BPEDB database:

   • If you want to use the Create tables option on the Business Process Choreographer configuration page, to have Business Process Choreographer create the default schema the first time that it uses the database, perform the following:

     1. If the database does not already exist, create an empty database using the database tool of your choice.
     2. 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 SQL scripts that are generated by the administrative console wizard to create the tables, as described in Use a generated script to create the database schema for Business Process Choreographer.

4. Create the database for the data store for the Business Process Choreographer messaging engine:

   • If you want to use the Create tables option on the Business Process Choreographer configuration page, to have the messaging engine create the default schema the first time that it uses the database (the next time that the messaging engine is started), perform the following:

     1. If the database does not already exist, create an empty database using the database tool of your choice.
     2. 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. In the administrative console, select the server or cluster where you want to configure Business Process Choreographer. Click either Servers > Clusters > WebSphere application server clusters > cluster_name or Servers > Server Types > WebSphere application servers > server_name.

7. Go to the Business Process Choreographer configuration page: In the Business Integration section, expand Business Process Choreographer and click Business Process Choreographer Containers.
8. Verify that Business Process Choreographer is not configured. There should be a message indicating whether the Business Flow Manager is already installed.

   If the Business Flow Manager and Human Task Manager are already installed, perform Advanced only: Removing the Business Process Choreographer configuration before continuing with the next step.

   If the Business Flow Manager and Human Task Manager are already installed, perform Remove the Business Process Choreographer configuration before continuing with the next step.

9. Enter the values and select the options that you planned for the Business Process Choreographer configuration on this server or cluster. For more information see Business Process Choreographer configuration.

10. Click Apply. Information is displayed reporting the progress deploying and configuring Business Process Choreographer.

11. If the installation succeeded, click Save Changes. Otherwise, discard the changes, check the administrative console and the SystemOut.log file on the Deployment Manager or server for any error messages that can help you correct the problem, then try again.
12. To create the database schema, you or your database administrator should perform the actions described in Use a generated script to create the database schema for Business Process Choreographer before you activate Business Process Choreographer in step 13.

    If you do not perform the actions described in Use a generated script to create the database schema for Business Process Choreographer, but your database will exist by the time you activate Business Process Choreographer in step 13, selecting the Create tables option means that the default schema will be created the first time that Business Process Choreographer accesses the database.

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

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

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

16. Depending on the type of people directory provider that you use for people assignment, you might need to configure it:

    • The system and user registry people directory providers can be used without configuring them.

    • If you are using Lightweight Directory Access Protocol (LDAP), perform Configure the LDAP people directory provider.

    • If you are using the Virtual Member Manager (VMM), perform Configure the Virtual Member Manager people directory provider.

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

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

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

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

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

22. If you have not yet installed and configured Business Process Choreographer Explorer, you can configure it now. Perform Configure Business Process Choreographer Explorer.

23. 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.
24. If you want to configure a remote Business Process Choreographer client that uses the Process Server client, perform, Configure a remote client application.

Results

Business Process Choreographer is configured.

What to do next

If you have not configured the Common Event Infrastructure yet, perform Configure CEI event services.

Configure Business Process Choreographer

Related tasks:
Troubleshooting the Business Process Choreographer configuration