IBM BPM, V8.0.1, All platforms > Install IBM BPM > IBM BPM Advanced > Install IBM BPM Advanced > On Windows > Network deployment environment > Configure profiles and create an ND environment > Create an ND environment > Use the administrative console > 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

deleteBPMApiFederationDomain command

Use the deleteBPMApiFederationDomain command to delete a federation domain including the contained targets.

This command deletes a federation domain and its contained targets for federating 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.

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 deleted. 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 administered 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 administered 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 administered on the cell scope.

-name federation_domain_name

The name of the federation domain that you want to delete. This name must be unique. This parameter is always required.

Examples

The following example uses the deleteBPMApiFederationDomain command to delete a federation domain

• Jython example:

  AdminTask.deleteBPMApiFederationDomain('[-nodeName myNode -serverName myServer -name myFederationDomain]') 

• Jacl example:

  $AdminTask deleteBPMApiFederationDomain {-nodeName myNode -serverName myServer -name myFederationDomain}

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