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 > Configure REST services > Configure all REST services on the administrative console

Configure REST services for a server, cluster, or component

Configure Representational State Transfer (REST) services for a server, cluster or a component by using the REST Services administrative console page.

Before you complete this task, you must have installed IBM BPM.

The deployment of the REST services is performed automatically in a stand-alone server profile. For other types of configurations, the REST Services administrative console page allows you to configure services for a server, a cluster, or a component.

This task configures the REST service provider application for a particular server or cluster. You must configure the provider application before REST services are available on a server or cluster. For more on REST service providers, see Configure REST services in a service provider.

You also must register the REST endpoints with the Business Space component so that widgets are associated with the endpoints, and the widgets appear in Process Portal for use. To ensure that the REST endpoints are registered, see Configure the Business Space component and registering REST endpoints on the administrative console.

If you want to configure multiple instances of the same REST service endpoint, you must manually edit the endpoints file and the widgets metadata file.

The REST Services Gateway application enables common system REST services. The REST Services Gateway application is created when REST services are configured.

Procedure

1. Click one of the following.

   • For REST services on a server, click: Servers > Server Types > WebSphere application servers > name_of_server > Business Integration > REST Services

   • For REST services on a cluster, click: Servers > Clusters > WebSphere application server clusters > name_of_cluster > Business Integration > REST Services

   • For business process REST services on a server, click: Servers > Server Types > WebSphere application servers > name_of_server > Business Integration > Business Process Choreographer > Business Flow Manager > REST Services

   • For business process REST services on a cluster, click: Servers > Clusters > WebSphere application server clusters > name_of_cluster > Business Integration > Business Process Choreographer > Business Flow Manager > REST Services

   • For human task REST services on a server, click: Servers > Server Types > WebSphere application servers > name_of_server > Business Integration > Business Process Choreographer > Human Task Manager > REST Services

   • For human task REST services on a cluster, click: Servers > Clusters > WebSphere application server clusters > name_of_cluster > Business Integration > Business Process Choreographer > Human Task Manager > REST Services

   The REST Services page appears, displaying all default REST services that you can configure for widgets for use with your product or component. If a REST service has already been configured, you see a message displayed.

2. Select a Protocol from the list for all REST services that you want to configure so they are available in IBM BPM Process Portal. Configure a full URL path by selecting either https:// or http:// and then completing the Host Name or Virtual Host in a Load-Balanced Environment and Port fields. Use a fully qualified host name.

   If you want REST requests to go directly to the application server, type the application server host name and port. If you want REST requests to go to a proxy server or HTTP server that sits in front of one or more application servers, type the host name and port of the proxy server or HTTP server that you have already set up. In an environment with a load balancer or proxy server between the browser and the REST services, make sure that what you designate for the protocol, host, and port matches the browser URL for accessing Process Portal. This same restriction applies for all environments that use Flex-enabled widgets.

3. In the table of REST services, in each row, select the Enabled check box if you want to enable the individual REST service, or clear the Enabled check box if you want to disable the individual REST service.

4. In the table of REST services, type a meaningful description for each of the REST services in the Description field.

5. Click OK to commit the changes to the services.

   To modify the REST service configuration at a later time, you can come back to the REST Services page or you can use other administrative console pages to manage the configuration of REST service endpoints. The REST service providers page allows you to select service provider that you want to configure. The REST services page accessed from Services > REST services allows you to configure all REST services in your environment.

What to do next

• Configure the Business Space component and Process Portal for your ND environment.

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

• For multiple instances of service endpoints, for example if you have partitioning of work on two clusters, and you want to have widgets showing data from each cluster, you must enable the additional widgets manually for each additional cluster.
• Set up security for the Business Space component and Process Portal.

Configure all REST services on the administrative console

Related tasks:
Configure the Business Space database
Enabling widgets for cross-cell environments
Enabling widgets to work with multiple endpoints
Configure the Business Space component using the command line