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 you have a web content viewer based on the older IBM API, you 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 that is associated with the portlet instance is converted into portlet preferences.

To convert the instances and settings of the IBM API web content viewer to the JSR 286 viewer, complete the following steps:

  1. Update the file wp_profile_root/ConfigEngine/wkplc.properties. Confirm that 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_root/PortalServer/wcm/config/portletconversion.properties.
    Note: If the following conditions are true, no changes are required and you can 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, you 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

    Specify a list of unique names of pages, separated by commas. If you specify this property, only portlets on these 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. You can 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. Change to the directory wp_profile_root/ConfigEngine.
  4. Run the task ConfigEngine convert-wcm-rendering-portlet.
    Windows
    ConfigEngine.bat convert-wcm-rendering-portlet
    UNIX
    ./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 successful conversion, you can uninstall the IBM API web content viewer.