Deploying Portlet

Portlet deployment
You deploy the Web components portlet by adding it to your portal configuration.
The Web components portlet is packaged as a WAR file in the IICE_HOME/opt/vbr_portlet.war file, where IICE_HOME is the WebSphere Information Integrator Content Edition installation directory. Unlike a typical WAR file, vbr_portlet.war does not represent a complete J2EE Web application. The file represents resources to be added to your existing portal Web application. You will need to unzip this file and add its resources to your portal Web application. You can then install the Web components portlet into the palette of your portal application, and add and configure any number of portlet instances to point to one or more Web components instances.

Add the contents of the portlet WAR file into your portal application resources
The contents of this WAR file are:

WEB-INF/web.xml
A fragment of XML that should be added to the portlet Web application WEB-INF/web. xml file. It contains a definition and mapping for a proxy servlet that maps requests for various resources required by the portlet (images, stylesheets, and so on) to the content integration server Web client application that backs the Web components portlet instances.

WEB-INF/portlet.xml
A portlet.xml file (according to the JSR 168 specification) whose contents should be added to the portlet Web application WEB-INF/portlet.xml file. If your Web application does not yet have a WEB-INF/portal.xml file, this file can be renamed and moved to the correct location. The file contains the Web components portlet definition and default initialization parameters.

WEB-INF/lib/vbr.jar and WEB-INF/lib/vbr_wc.jar
Library JAR files that contain the implementation of the Web components portlet, proxy servlet, and their required classes. These JAR files should be added to your portal Web application WEB-INF/lib directory.

Add the Web components portlet to the palette of your portal application
If your portal supports JSR 168, you must deploy a JSR 168 portlet to add it to the palette of available portlets for your portal. The detailed instructions and tools involved in this step will vary from vendor to vendor.

Add and configure one or more instances of the Web components portlet
The Web components portlet has several initialization parameters and several preferences. Initialization parameters will typically be the same for all instances of the portlet in your portal, and are used primarily to locate the Web client application instance that is backing the portlets. The default values for these parameters have been set to reference the Web client application instance included in VeniceBridge.ear file and deployed within the same application server instance as the portal Web application. The following parameters are defined in the portlet definition in the portlet.xml file:

VbrLoggingLevel
The logging level for content integration server portlets (error, warn, info, or debug). The logging level controls the console or log file output for requests directed at the portlet.

VbrBaseWebComponentsUrl
The base URL for the target content integration server Web client application that is hosting the Web components portlets' referenced Web component instances.

VbrProxyServletUrlMapping
The URL mapping in the portal Web application for the content integration server proxy servlet. The mapping must match the URL pattern in the servlet mapping for the content integration server proxy servlet in the portal Web application WEB-INF/web.xml file.

VbrWebComponentsUrlSuffix
The suffix in the content integration server Web client application that is mapped to the Web components servlet.

A portlet preference is used to select the particular Web component instance that backs each portlet instance. A preference is used instead of an initialization parameter because the value of the preference is expected to be different for each instance of the portlet, while initialization parameters are expected to be the same for all instances of the Web components portlet. The following preferences can be specified:

VbrComponentId
This value must refer to a valid component ID from the wc-config.xml file (required).

VbrComponentUrl
A valid absolute URL here will override the default URL computed from the component ID (optional).

Ensure that the content integration server Web client application is running and update or restart the portal application
After you modify the configuration files and add new resources, most application servers require you to perform a redeployment or restart of the portal Web application, or even a complete restart of the application server.

In addition, you should ensure that the Web client application instance that supports your portlets is up and running. In the default portlet configuration, this means that VeniceBridge.ear file should be deployed in the application server instance that is hosting the portal Web application.
  • Building, deploying, and running a portlet for a WebSphere portal
         You can use the WebSphere Portal administration tools to deploy the Web components portlet to a WebSphere portal
  • Deploying a portlet to a WebLogic portal
         You can use the WebLogic administration tools to deploy the Web components portlet to WebLogic portal.

No comments:

Post a Comment