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 > Commands (wsadmin scripting) for configuring the Business Space component for Process Portal

createBPMApiFederationDomain command

Use the createBPMApiFederationDomain command to configure the federation domains in an environment with multiple deployment targets so that you can display processes and tasks created in Process Designer and Integration Designer in the same task list.

The createBPMApiFederationDomain command with the addTarget step creates a federation domain to federate tasks and processes across one or more deployment targets. The Federation API allows you to display processes and tasks created in Process Designer and Integration Designer in the same task list. 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 to create and manage federation domains. Use the addTarget step to add one or more deployment targets to a federation domain. The Federation API federates over all systems on the added deployment targets.

After using the command, save your changes to the master configuration using one of the following commands:

• For Jython:

  AdminConfig.save()

• For Jacl:

  $AdminConfig save

If the application server is not running, supply the -conntype NONE option when running this command.

Target object

Scope at which the federation domain is to be created. The target object can be used instead of the nodeName, serverName and clusterName parameters.

Required parameters

-serverName server_name

A parameter that specifies the name of the server on which the federation domain should be administered. If this parameter is specified, the nodeName parameter must be specified. Do not specify this parameter if the clusterName parameter or a target object is specified. If no deployment target is specified, the federation domain is created on the cell scope.

-nodeName node_name

A parameter that specifies the name of the node on which the federation domain should be administered. If this parameter is specified, the serverName parameter must be specified. Do not specify this parameter if the clusterName parameter or a target object is specified. If no deployment target is specified, the federation domain is created on the cell scope.

-clusterName cluster_name

A parameter that specifies the name of the cluster on which the federation domain should be administered. Do not specify this parameter if the nodeName and serverName parameters or a target object are specified. If no deployment target is specified, the federation domain is created on the cell scope.

-name federation_domain_name

The name of the new federation domain that you are creating. This name must be unique. This parameter is always required.

Required parameters for the addTarget step

-targetCellName cell_name

A parameter that specifies the name of the cell that is used as federation target. If this parameter is specified and the nodeName, serverName and clusterName parameters are not specified, the federation API federates across all systems in the cell.

-targetNodeName node_name

A parameter that specifies the name of the node that is used as federation target. If this parameter is specified, the federated API will federate across the systems on this node. If this parameter is specified, then the targetServerName parameter must be specified. Do not specify this parameter if the targetClusterName parameter is specified.

-targetServerName server_name

A parameter that specifies the name of the server that is used as federation target. If this parameter is specified, the federated API will federate across the systems on this server. If this parameter is specified, the targetNodeName parameter must be specified. Do not specify this parameter if the targetClusterName parameter is specified.

-targetClusterName cluster_name

A parameter that specifies the name of the cluster that is used as federation target. If this parameter is specified, the federated API federates across the systems on this cluster. Do not specify this parameter if the targetNodeName or targetServerName parameter are specified.

Examples

The following example uses the createBPMApiFederationDomain command to add a federation domain with the 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}}}

Commands (wsadmin scripting) for configuring the Business Space component for Process Portal

Related tasks:
Enabling the Federation API across multiple deployment targets

Related information:

Obtaining online help using wsadmin scripting
Administrative command invocation syntax using wsadmin scripting
Use the wsadmin scripting tool
Jython script library