Using the REST Grid Widget

Use the REST Grid widget to pull data from any Web service that supports the REST format and display that data on custom forms.

For advanced REST grid functions that you can implement with JavaScript, see Advanced Functions.

REST Grid Widget Examples

Example 1

As part of creating a product incident request, a service representative needs to select the product that an incident is related to from a list. Instead of replicating the product data in SBM to populate the list, use a REST Grid widget to retrieve the information dynamically from the company's product catalog. The REST Grid widget can also display product images, so the representative has a visual way to select the product.

Example 2

A writer for a financial magazine has an item assigned to him for each date he needs to submit an article for publication. The custom form for the New state has a REST Grid widget that returns the financial questions people asked on the magazine's Web site. The writer uses these questions as ideas for the content of the article.

Follow these steps for basic widget configuration:

Add or edit a custom state or transition form.
Drag the REST Grid widget from the Widgets section of the Form Palette to the form editor.
Complete the General tab of the widget Property Editor:
1. Type a name in the Control name box.
2. In the Caption box, provide information you want to show in the widget title bar.
3. Click the Configure URL button. The REST Service Configuration dialog box opens.
4. Configure the REST service, using the information in REST Service Configuration Dialog Box for guidance.
On the Result tab of the widget Property Editor, choose to render the widget as a grid or tiles, then move Available data items to the Grid columns or Tile Content pane.
Select other options on the Result tab, using the information in Result Tab for guidance.

Authentication Considerations

When you type a URL to a REST service that requires basic authentication, a popup window is automatically presented, in which you type the user name and password. (The REST service provider sends you the user name and password when you register for the service.)

Important: If the SBM Server is set up with Microsoft Windows NT Challenge/Response authentication, the SBM Server must be configured in a specific way to ensure that the REST Grid widget works. For more information, see the SBM Installation and Configuration Guide.