IBM BPM, V8.0.1, All platforms > Install IBM BPM > IBM BPM Advanced for z/OS: Process Server > Configure IBM BPM Advanced for z/OS: Process Server > Configure components > Configure additional components > Configure Process Portal > Configure the Business Space component for Process Portal > Configure the Business Space component for ND environments

Enabling the Federation API across multiple deployment targets

The Federation API allows you to display processes and tasks created in Process Designer and Integration Designer in the same task list. If your environment has multiple clusters in the same cell or includes multiple cells, you must manually configure the federation domains using commands.

This topic applies to the following products:

• IBM BPM Advanced
• IBM BPM Standard

Before you complete this task, :

• Install the product.

• Create profiles, and configure Business Space on a deployment target (server or cluster).

• Configure the database tables (if you are using a remote database or deployment environment).

The Federation API is automatically configured with your product as part of the REST Services Gateway application. If you want to change that configuration for your environment with multiple deployment targets, use wsadmin commands.

Procedure

1. Open a command window.

   The wsadmin command can be found in the profile_root/bin directory for a stand-alone server environment, or in the deployment_manager_profile_root/bin directory for an ND environment.

2. At the command prompt, type the wsadmin command to start the wsadmin environment.

3. Use the createBPMApiFederationDomain command to create a federation domain, and use the addTarget step to federate the domain across one or more deployment targets.

   For the name parameter, the federation_domain_name must be unique.

   The following example adds a federation domain with name myCustomFederationDomain that federates across a server (with the node name myNode and server name myServer) and a cluster (with the name myCluster).

   • Jython example:

     AdminTask.createBPMApiFederationDomain('[-nodeName node_name -serverName server_name -name myCustomFederationDomain -addTarget [["" myNode myServer ""] ["" "" "" myCluster]]]')

   • Jacl example:

     $AdminTask createBPMApiFederationDomain {-nodeName node_name -serverName server_name -name myCustomFederationDomain -addTarget {{"" myNode myServer ""} {"" "" "" myCluster}}}

What to do next

Other commands are available if you need to modify the Federation API configuration.

• If you want to delete a federation domain including the contained targets, use the deleteBPMApiFederationDomain command.

• If you want to list all federation domains, use the listBPMApiFederationDomains command.

• If you want to add or remove targets from a federation domain, use the modifyBPMApiFederationDomain command.

• If you want to display details about a federation domain, use the showBPMApiFederationDomain command.

Configure the Business Space component for ND environments

Related reference:
createBPMApiFederationDomain command
deleteBPMApiFederationDomain command
listBPMApiFederationDomains command
modifyBPMApiFederationDomain command
showBPMApiFederationDomain command

Related information:
REST APIs and federated environments