Configure REST services using the command line

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 > Configure the Business Space component for ND environments > Configure REST services
Configure REST services using the command line

All widgets required for your product are installed with the Business Space component. The Representational State Transfer (REST) services for widgets must be configured, enabled, and registered with Business Space before your team can use Process Portal. If you do not use the REST Services administrative console page, use the updateRESTGatewayService command.

Before you complete this task, you must have installed IBM BPM.
For IBM BPM, if you have configured Business Process Choreographer, the Human Task Management REST services are already configured. However the REST Services Gateway application, which is a service provider for other REST services, must be configured with the updateRESTGatewayService command.

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 or the updateRESTGatewayService command allows you to configure services for REST API for all of your product's widgets.
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.
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.

Procedure

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.
At the command prompt, type the wsadmin command to start the wsadmin environment.
Use the updateRESTGatewayService command to configure REST services specifying the cluster or the server and node. The -enable parameter is optional, and if not specified, defaults to true.
Run the save command.

Example

The following example uses Jython to run the updateRESTGatewayService command and then save the changes. It configures the REST services on a cluster.
AdminTask.updateRESTGatewayService('[-clusterName
  cluster_name]')
AdminConfig.save()
The following example uses Jacl:
$AdminTask updateRESTGatewayService {-clusterName
  cluster_name} $AdminConfig save
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 REST services

Related tasks:
Enabling widgets for cross-cell environments:
Enabling widgets to work with multiple endpoints:

Related reference:
updateRESTGatewayService command: