Customizing Business Process Choreographer
Business Process Choreographer supports enterprise applications that contain BPEL
processes or human tasks. Business Process Choreographer is
configured by default when you use the BPMConfig command or the deployment
environment wizard to create your IBM® BPM
Server environment. Depending on your requirements, you might need to perform further
customization.
Procedure
- Optional: Verify that the basic Business Process Choreographer configuration works:
- Optional: The Business Process Choreographer configuration includes a Business Process Choreographer Explorer configuration. To view or modify the Business Process Choreographer Explorer settings using the administrative console, click Servers > Clusters > WebSphere application server clusters > cluster_name, then on the Configuration tab, in the Business Process Manager section, expand Business Process Choreographer, and click Business Process Choreographer Explorer.
- If you want to the Human Task Manager
to be able to send escalation emails, you must use the administrative
console to configure the settings for the Human Task Manager.
- Set the email sender address and email URL link prefixes, click Servers > Clusters > WebSphere application server clusters > cluster_name, then on the Configuration tab, in the Business Process Manager section, expand Business Process Choreographer, and click Human Task Manager, and complete the settings for the sender address and the prefixes for link URLs that are included in escalation emails.
- To set the email server address, port number, the user ID, and 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. Enter your settings.
- Set the context roots and endpoints.
- 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 actions:
- 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 orBPArchiveMgr
for a Business Process Archive Manager configuration, and suffix is the name of the cluster 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
- 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 orTaskArchiveMgr
for a Business Process Archive Manager configuration, and suffix is the name of the cluster 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
- To change the REST URLs that the Business Process Choreographer
Explorer uses:
- Click Servers > Clusters > WebSphere application server clusters > cluster_name . On the Configuration tab, in the Business Process Manager section, expand Business Process Choreographer and click Business Process Choreographer Explorer. Update the Business Flow Manager and Human Task Manager REST API URLs.
- 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/'])
- 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
- If you changed any of the context roots for the Business
Flow Manager or Human Task Manager you must also modify the corresponding
endpoints:
- 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 Servers > Clusters > WebSphere application server clusters > cluster_name,
then on the Configuration tab, in the Business Process Manager section, expand Business Process Choreographer, and click Business Process Choreographer Explorer, select
the
BPCExplorer_scope
orBPCArchiveExplorer_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.Note: 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. - If you use the Business Space: Change
the REST endpoints to match the new context roots by clicking Servers > Clusters > WebSphere application server clusters > cluster_name,
then on the Configuration tab, in the Business Process Manager 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.Note: 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.
- 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 Servers > Clusters > WebSphere application server clusters > cluster_name,
then on the Configuration tab, in the Business Process Manager section, expand Business Process Choreographer, and click Business Process Choreographer Explorer, select
the
- 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.
- 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. Make sure 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. - 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 Configuring the LDAP people directory provider.
- If you are using the Virtual Member Manager (VMM), perform Configuring the Virtual Member Manager people directory provider.
- Optional: If you configured VMM, and you want to use people substitution, perform Configuring people substitution.
- Optional: If you
want to use group work items, use the administrative console to enable
them. Click Servers > Clusters > WebSphere application server clusters > cluster_name, then on the Configuration tab, in the Business Process Manager section, expand Business Process Choreographer, and click Human Task Manager, then select Enable group work items.
- 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 Configuring Common Secure Interoperability Version 2 inbound communications.