WebSphere

Enabling Business Space widget REST service endpoints on the administrative console

All widgets required for your product are installed with Business Space powered by WebSphere®. The Representational State Transfer (REST) service endpoints for widgets must be deployed and registered with Business Space before your team can use the widgets in Business Space.

Before you begin

Topic scope: This topic applies to the following products:
  • WebSphere Process Server
  • WebSphere Enterprise Service Bus
Before you complete this task, you must have completed the following tasks:
  • Installed the product.
  • Configured a profile, and configured Business Space on that profile.
  • Configured the database tables (if you are using a remote database or deployment environment).

About this task

The deployment of the REST services is performed automatically in a stand-alone server profile. For other types of configurations, the System REST Service Endpoints administrative console page allows you to configure service endpoints for REST application programming interfaces (APIs) for all of your product's widgets in Business Space. These REST endpoints are automatically registered with Business Space. Then Business Space automatically associates widgets with these endpoints, and the widgets appear in the palette 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. For more information, see "Enabling Business Space widgets for multiple endpoints.

Procedure
  1. Click one of the following.
    • For system REST services on a server: Servers > Application servers > servername > Business Integration > System REST Service Endpoints
    • For system REST services on a cluster: Servers > Clusters > clustername > Business Integration > System REST Service Endpoints
    • For business process REST services on a server: Servers > Application servers > servername > Business Integration > Business Flow Manager > REST Service Endpoint
    • For business process REST services on a cluster: Servers > Clusters > clustername > Business Integration > Business Flow Manager > REST Service Endpoint
    • For human task REST services on a server: Servers > Application servers > servername > Business Integration > Human Task Manager > REST Service Endpoint
    • For human task REST services on a cluster: Servers > Clusters > clustername > Business Integration > Human Task Manager > REST Service Endpoint

    The System REST Service Endpoints page appears, displaying all default REST service endpoints that you can configure for Business Space widgets for use with your product or component (Business Flow Manager or Human Task Manager). If a REST service endpoint 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 Business Space. Configure a full URL path by selecting either https:// or http:// and then type the Host Name or Virtual Host in a Load-Balanced Environment and Port. If you are using a server that is secured with administrative and application security, make sure to select https:// so Business Space widgets can reach the endpoints and will work properly. If you plan to deploy a secured environment, make sure to enable both the administrative and the application security for the widgets to work correctly. For more information about application security, see "Setting up security for Business Space."
  3. In the table of REST services, type a meaningful description for each of the REST services in the Description field.
  4. Click OK to commit the changes to the endpoints files.

What to do next

  • For other service endpoints for widgets included with WebSphere Business Monitor and WebSphere Modeler Publishing Server, you must enable widgets manually in the endpoints files.
  • 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 Business Space.

task Task topic

Terms of use | Feedback


Timestamp icon Last updated: 22 June 2010


http://publib.boulder.ibm.com/infocenter/dmndhelp/v6r2mx/topic/com.ibm.websphere.wbpm.bspace.config.620.doc/doc/tcfg_bsp_rest_endpoints.html
Copyright IBM Corporation 2005, 2010. All Rights Reserved.
This information center is powered by Eclipse technology (http://www.eclipse.org).