The web portlet component is used to display web pages within a tab. It can be configured to show information or images from external sources such as internet web sites, corporate intranet systems, or any other source that can be accessed by specifying a URL.
The web portlet can be used to retrieve information relevant to an item from a target web server. The server retrieves specific information for each item using the web portlet.
Example 1: In a system where items represent companies, a web portlet can be configured to display information from a stock market site relevant to the company (such as stock history chart). The item should carry the stock symbol in a pre-configured category.
Example 2: In a system where items represent products, a web portlet can be configured to display the image of a product directly from an inventory related web site. Assuming that the web site needs a product number (SKU) in the URL to display the correct image, each item (product) should carry the relevant SKU in a pre-configured category.
To insert a Web Portlet:
- Follow the general steps described in Inserting a Component.
- Select Web Portlet from the Component drop-down list. The label `Web Portlet' is automatically entered in the Label cell.
- To configure the Web Portlet, click Edit.
The Web Portlet dialog box appears.
- Enter the desired URL (http address) in the Link field.
Note: When creating a Web Portlet, be sure that the users have access to the site you are defining.
In the Additional Query String table, you can add URL parameters that contain information from categories or items. These parameters are appended to the URL in the Link field. The system will automatically determine if a question mark is needed to separate the address part from the query string in the URL. Specify the parameter name, as required by the URL and select the category from which the parameter gets its value.
Item name and the item id are not category values. To include the item name or the item id in the URL, check the relevant box and select the parameter name from which the parameter gets its value.
Note:
- You may set a maximum of five parameters that receive values from categories per web portlet. The URL in the Link field may include additional parameters that have fixed values (not values from categories).
- Make sure that the parameter names are recognized by the web server you are accessing.
- For each category parameter name, double-click the Category cell to the right of the parameter. A pop-up list of categories appears. Choose the category for that parameter. The value of the parameter is appended to the URL link when the system tries to access the URL location. For example, to add the parameter symbol to a URL, enter the parameter name symbol in the Parameter Name column and select the category StockSymbol in the Category column. For example, if the StockSymbol of the item was ORCL, then the system appends the string symbol=ORCL to the URL.
- You may check the Item ID check box and enter a parameter name. The item's ID will be added to the web portlet's URL address.
- You may check the Item Name check box and enter parameter name. The item's name will be added to the web portlet's URL address.
- Enter a description of the web portlet in the Description box.
Note: The description will be seen only in the Web Portlet dialog box, not on the tab.
- Click OK to return to the Tab.
- Double-click the Height cell to adjust the height of the Web Portlet. The default height is 12 rows.