Previous Topic: Use the Request Widget to Let Users Request ServicesNext Topic: Call the Browse Widget Using Source Code


Call the Browse Widget Using Menu Options

In Liferay, using the CA Service Catalog WAR files let you configure the display and behavior of CA Service Catalog widgets in portlets by using menu options. Review the following steps for producing the earlier Browse widget example. Follow them as a model for using Liferay to configure the display and behavior of the Browse widget in your implementation.

Follow these steps:

  1. On the portal page, click Add, More.

    The list of preconfigured portlets appears.

  2. Expand CA Service Catalog on the list, select Browse, and click Add. Alternatively, drag-and-drop Browse onto the location you want.

    The Browse portlet gets added to Liferay.

  3. Close the list, and click Edit Controls at the top of the page.
  4. Mouse-over the Browse widget, click the wrench (Options) icon, and select Preferences from the drop-down list.

    The Editing Catalog Browse Portlet Settings appears.

  5. Review the following key parameters for the earlier Browse widget example. Use them as a model to configure your portlet settings.
  6. Save your settings and review the portlet. If necessary, refine your settings to meet your requirements.

You have called the Browse widget and configured its display and behavior in the portlet.

Key Parameters

The key parameters for the earlier Browse widget example follow:

Catalog URL=http://host-name:port-number/usm

Important! You must include the "/usm" in the URL for the portlet to render correctly.

Specifies the URL for the catalog.

Use the same host name and port number as when you downloaded and installed the WAR Files in Liferay.

Authentication Type

Specifies whether to authenticate users using single sign-on (Windows NTLM) or login credentials. We recommend single-sign-on for widgets.

If you specify single-sign-on, users are not prompted for login credentials.

If you specify login credentials, use the following format:

User name=username and Password=password

Business Unit=London222

Specifies the business unit that catalog users can access while utilizing this Browse widget. Users can browse services in all folders in this business unit.

For example, if you specify the root business unit, catalog users can browse services from all folders in all business units, including the root business unit. Conversely, if you specify the name of the lowest level business unit, catalog users can browse services from folders in that business unit only.

If you do not specify a value, the Catalog system uses the default business unit of the user accessing the widget.

Offering ID=1001

Specifies the object ID of the folder or service that the Browse widget displays. In this example, 1001 is the root folder of the catalog of the business unit.

You can specify either a single folder or a comma-separated list of services, using their object IDs.

Note: The folder or service that you specify must exist in a business unit that the user can access, as explained in the Business Unit parameter.

Layout=Name and Icon

Displays the names and icons (without descriptions) of the services that appear in the Browse widget.

Alternatively, you can display the names, icons, and descriptions of the services.

Open In=Send local event which other widgets can listen

Specifies that another widget on the same page listens to events from the Browse widget and responds to them. In this scenario, when the user clicks a service, the Request widget responds by opening the service. You must add the Request widget to this page to enable this function.

Open In specifies how a service opens in the Request widget when the user clicks the service on the Browse widget. Other possible values for this parameter follow:

Raise request in same page

Opens the service in the catalog, on the same page.

Raise request in top most frame

Performs the same function as _self, except that the service opens in the top-most frame of the browser. If the service is a frame, then the first associated frame in service option element is selected.

Opens a new window

Opens the service in the catalog, on a new page. The user request the service on that page.

URL

Opens the service using a custom URL. The URL can include a placeholder for the object ID of the service. An example follows:

http://www.google.com?id={id}
Show Tree=selected

Displays the sub folders of the main folder.

Note: To hide the subfolders, do not select this option.

Show Search=selected

Specifies that the Browse widget includes the Search field. Users can use this field to search the catalog for services, according to names or key terms.

Note: You can also specify the following settings, as shown in the menu options: show featured offerings, link color, border color, and background color.