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 in a service provider

Configure Representational State Transfer (REST) services in a service provider by using the REST service providers configuration 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 administrative console allows you to configure REST services for all of your product's widgets. On the REST service providers configuration administrative console page, you can view all services for a selected service provider and enable or disable each service individually. The page allows you to manage individual service configuration by working with all services for 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.

The following REST service providers are available and are configured on the scope shown:

• REST Services Gateway: To add a REST Services Gateway for a given scope, navigate to Servers > Server types > my_server > Business Integration > REST services or Servers > Clusters > my_cluster > Business Integration > REST services. Configure the REST services gateway provider for the given server or cluster.
• REST Services Gateway Dmgr: The REST Services Gateway provider on the dmgr is configured automatically when creating a dmgr profile for IBM BPM or WebSphere Enterprise Service Bus. This provider hosts administrative REST services used by the Module Browser, Module Administration, Health Monitor and Proxy Gateway widgets.
• BPEContainer: REST services for business processes are provided by the Business Process Execution container. To configure the container and its REST services, select Servers > Server types > my_server > Business Integration > Business Process Choreographer > Business Flow Manager or Servers > Clusters > my_cluster > Business Integration > Business Process Choreographer > Business Flow Manager.
• TaskContainer: REST services for human tasks are provided by the Human Task container. To configure the container and its REST services, select Servers > Server types > my_server > Business Integration > Business Process Choreographer > Human Task Manager or Servers > Clusters > my_cluster > Business Integration > Business Process Choreographer > Human Task Manager.

Procedure

1. Click Services > REST services > REST service providers .

   The REST service providers page opens, displaying all REST service providers.

2. Click a provider link to configure the services for the group of REST services managed by that provider.

   The REST service providers configuration page opens, displaying all REST services in the provider.

3. 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

4. In the table that lists the REST services for the provider, 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.

5. For each individual service that you want to enable, type a meaningful description in the Description column.

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

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
Configure the Business Space component and registering REST endpoints on the administrative console
Enabling widgets for cross-cell environments
Enabling widgets to work with multiple endpoints