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

Registering widget REST service endpoints using the command line

If you configure the Business Space component using the administrative console, you must register Representational State Transfer (REST) endpoints so that your team can use IBM BPM widgets in Process Portal.

If you do not register your endpoints on the administrative console using the Business Space Configuration and the System REST service endpoint registration pages, you can use the registerRESTServiceEndpoint command.

Before you complete this task, :

• Install the product.

• Configure the REST services for the widgets that you are you using in Process Portal by using the REST Services administrative console page or the updateRESTGatewayService command.

  If you have a stand-alone server environment or you are using the Deployment Environment wizard to configure your runtime environment, the REST services are configured and enabled automatically. You configure REST services for business processes and human tasks by configuring the Business Process Choreographer and the Human Task Manager container.

• Configure the Business Space component by using either the Business Space Configuration administrative console page or the installBusinessSpace and configureBusinessSpace commands.

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

REST services are registered automatically if you have a stand-alone server environment and you configured the Business Space component with the administrative console or pmt.sh, or if you used the Deployment Environment wizard to configure your runtime environment. Otherwise, configure the REST services and then register them.

You can use the System REST service endpoint registration administrative console page or the registerRESTServiceEndpoint command to register endpoints for REST services for all of your product's widgets in Process Portal. Then the Business Space component automatically associates widgets with these endpoints, and the widgets appear in the palette for use.

You can use the registerRESTServiceEndpoint command to register a set of endpoints for a given provider, a deployment target, or all unique endpoints in a cell. This command registers the endpoints of the REST services that are in the same cell as Business Space.

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 registerRESTServiceEndpoint command to register the Business Space endpoints for REST services for all your product's widgets.

4. After each command, run the save command.

Example

The following example uses Jython to run the registerRESTServiceEndpoint command and then save the changes. It registers all configured and enabled REST services on the cluster with Business Space.

AdminTask.registerRESTServiceEndpoint('[-clusterName
  name_of_rest_services_cluster -businessSpaceClusterName
  name_of_business_space_cluster]')
AdminConfig.save()

where name_of_rest_services_cluster is the cluster name where REST services are configured and name_of_business_space_cluster is the cluster name where Business Space is deployed.

The following example uses Jacl:

$AdminTask registerRESTServiceEndpoint 
{-clusterName  name_of_rest_services_cluster
-businessSpaceClusterName  name_of_business_space_cluster} $AdminConfig save 

where name_of_rest_services_cluster is the cluster name where REST services are configured and name_of_business_space_cluster is the cluster name where Business Space is deployed.

The appName, webModuleName, type, name, version, nodeName, serverName, or clusterName parameters are optional.

If you do not specify type, appName, and webModuleName parameters, all unique REST service endpoints configured on the deployment target are registered.

If you do not specify any of those parameters, all unique REST service endpoints configured on any deployment target are registered.

What to do next

Tip: The Business Space component uses a proxy component to connect to your REST services. In some cases, if REST services are not responsive, you must update the connection timeout settings to your REST services, depending on the performance of the REST service servers. See Changing the timeout settings for the Business Space Ajax proxy.

Configure the Business Space component for ND environments

Related tasks:
Configure the Business Space component using the command line
Configure the Business Space database
Set up security for the Business Space component and Process Portal

Related reference:
registerRESTServiceEndpoint command