+

Search Tips   |   Advanced Search

Converting an IBM API Web Content Viewer to the JSR 286 API

As installed by default, the Web Content Viewer is based on the JSR 286 API. If we have a Web Content Viewer based on the older IBM API, we can convert the viewer to the JSR 286 API. Use the convert-wcm-rendering-portlet task to convert the IBM API Web Content Viewer settings and instances to the JSR 286 Web Content Viewer portlet.

The convert-wcm-rendering-portlet task converts portlet settings of the IBM API Web Content Viewer to portlet preferences of the JSR 286 Web Content Viewer. The task also converts instances of the IBM API Web Content Viewer to instances of the Web Content Viewer. User customized portlet data associated with the portlet instance is converted into portlet preferences.

  1. Update the file WP_PROFILE/ConfigEngine/wkplc.properties. Confirm the user IDs and passwords are set as required, or modify them if necessary.

  2. Update or verify the properties in the file WP_PROFILE/PortalServer/wcm/config/portletconversion.properties.

    If the following conditions are true, no changes are required and use the default values in the properties file.

    • There are no clones of the IBM API Web Content Viewer.

    • You want to convert all instances of the portlet on all pages in the default virtual portal.

    For specific situations, we can update the additional properties described in the following table.

    Scenario Properties to modify
    You want to convert instances of the portlet on specific pages in the default virtual portal. pages.uniquename

    Set a list of unique names of pages, separated by commas. If we specify this property, only portlets on those pages and their descendants are converted. If this property is empty or missing, instances of the IBM API Web Content Viewer on all pages are converted.

    You want to convert instances of the portlet in a virtual portal that is not the default virtual portal. xmlaccess.url

    Specify the URL of the virtual portal to the portal XML configuration interface servlet. Use this property to run conversions for specific virtual portals. If this property is empty or missing, the default portal is used to run the conversion.

    Example: xmlaccess.url=http://www.example.com:10039/wps/config/vp1

    You cloned the Web Content Viewer portlet and want to convert instances of the clone. Identify the clone by specifying one of the following properties:

    • ibmportlet.portletname

    • ibmportlet.uniquename

    • ibmportlet.objectid

    Only one of the properties is required to identify the portlet.

    For a complete list of properties for the portlet conversion task, see Converting portlet instances and settings from the IBM API to the standard API.

  3. cd WP_PROFILE/ConfigEngine.

  4. Run the task ConfigEngine convert-wcm-rendering-portlet.

      Windows
      ConfigEngine.bat convert-wcm-rendering-portlet

      AIX , HP-UX, Linux, Solaris
      ./ConfigEngine.sh convert-wcm-rendering-portlet

      IBM i
      ConfigEngine.sh convert-wcm-rendering-portlet

  5. Verify the conversion by reviewing the console. The message Build successful indicates a successful conversion. If the message Build failed is displayed upon completion of the task, review the previous steps.

  6. Verify the configuration of the converted Web Content Viewer. For more information about configuring a local Web Content Viewer, see the portlet help.

  7. After the successful conversion, we can uninstall the IBM API Web Content Viewer.


What to do next

If we make the web content available on the delivery portal using syndication, we can also convert instances of the IBM API Remote Web Content Viewer portlet to the JSR 286 portlet. When we make the web content available, we can transform the web content delivery model from remote rendering to local rendering. To convert instances and settings of the IBM API Remote Web Content Viewer portlet to the JSR 286 portlet...

  1. Edit the file wp_profile_root/PortalServer/wcm/config/portletconversion.properties.

  2. Change the following parameters as described here:

      ibmwebapp.uid
      The default value for this parameter is the unique identifier of the IBM API Web Content Viewer. Set the value to match the unique identifier of the IBM API Remote Web Content Viewer: com.ibm.workplace.wcm.app.ui.portlet.RenderingPortlet.30f9cb100a340018159bfdc657811d2e2

      ibmportlet.portletname
      The default value for this parameter is the portlet name of the IBM API Web Content Viewer. Set the value to match the portlet name of the IBM API Remote Web Content Viewer: Remote Web Content Viewer.

  3. Perform steps 1 - 5 of the procedure given earlier.

  4. Verify the configuration of the converted Remote Web Content Viewer portlet. For further information on configuring a local Web Content Viewer portlet, read Edit the settings of a web content viewer portlet.

  5. After the successful conversion, we can uninstall the IBM API Remote Web Content Viewer portlet.

If we made clones of the IBM API Web Content Viewer portlet or of the IBM API Remote Web Content Viewer portlet, or if you renamed the portlets, we might need to modify the parameters in the file wp_profile_root/PortalServer/wcm/config/portletconversion.properties that identify the portlet that we use as the source for the conversion. For a complete reference of all parameters the portlet conversion task supports, read Converting portlet instances and settings from the IBM API to the standard API.


Parent Web Content Manager

Related concepts:

Unsupported and deprecated features for V8.5

Related tasks:

Converting portlet instances and settings from the IBM API to the standard API


Related information


Edit the settings of a Web Content Viewer Portlet