Configuring 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 dashboards. If you do not use the REST Services administrative console page, use the updateRESTGatewayService command.

Before you begin

Before you complete this task, you must have installed IBM® Business Monitor.

The updateRESTGatewayService command is run using the AdminTask object of the wsadmin scripting client.

The following conditions must be met:

  • Run the command on the deployment manager node.
  • Run the command in the connected mode, that is, do not use the wsadmin -conntype none option.
  • You must connect with a user ID that has WebSphere® Application Server administrator privileges.

Start the wsadmin scripting client from the deployment_manager_profile/bin directory.

About this task

The deployment of the REST services is performed automatically in a stand-alone server profile and when using the monConfig script. For other types of configurations, the REST Services administrative console page or the updateRESTGatewayService command allows you to configure services for REST application programming interfaces (APIs) for all of your product's widgets.

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

  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 a network deployment environment.

  2. At the command prompt, type the wsadmin command to start the wsadmin environment.
  3. 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.
  4. 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 dashboards for your network deployment environment.
  • Configure the database tables (if you are using a remote database or a network deployment 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 dashboards.
Parent topic: Configuring REST services