+

Search Tips   |   Advanced Search

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

The portal provides a portlet conversion task that allows us to convert the settings and instances of IBM API portlets to the corresponding standard API portlets. This is useful when we intend to replace IBM API portlets by standard API portlets.

Use this task as follows: The portlet conversion task converts portlet settings of the IBM API portlet to portlet preferences of the standard API portlet. It also converts instances of the IBM API portlet to instances of the standard API portlet. User customized portlet data associated with the portlet instance is converted into standard API portlet preferences.

To convert the instances and settings of an IBM API portlet to a standard API portlet...

  1. Install the standard API portlet by which to replace the IBM API portlet.

  2. Create a portlet conversion properties file that identifies both the IBM API portlet and the standard API portlet. To do this, create or update the following file:

      APPSERVER_ROOT/ConfigEngine/properties/portletconversion.properties

    Confirm the following parameters are set as specified or modify them if necessary:

      For the IBM API portlet:

        ibmwebapp.uid
        The uid of the Web application containing the IBM API portlet. Required.

        Parameters for identifying the IBM API portlet:
        To identify the IBM API portlet, specify one of the following three parameters: the portlet name, the object ID, or the unique name of the IBM API portlet:

          ibmportlet.portletname
          The portlet name of the IBM API portlet.

          ibmportlet.uniquename
          The unique name of the IBM API portlet.

          ibmportlet.objectid
          The object ID of the IBM API portlet.

      For the standard portlet:

        jsrwebapp.uid
        The uid of the web application containing the standard API portlet. Required.

        Parameters for identifying the standard API portlet:
        To identify the standard API portlet, specify one of the following three parameters: the portlet name, the object ID, or the unique name of the standard API portlet:

          jsrportlet.portletname
          The portlet name of the standard API portlet.

          jsrportlet.uniquename
          The unique name of the standard API portlet.

          jsrportlet.objectid
          The object ID of the standard API portlet.

      Additional parameters:

        pages.uniquename
        Optional. Set a comma separated list of unique names of pages. If we specify this parameter, only portlets on these pages and their descendants are converted. If we leave this parameter empty or missing, instances of IBM API portlets on all pages are converted.

        converter
        The name of a converter class invoked by the porltetconversion task and that performs the conversion of portlet settings and portlet data. The converter class implement the interface com.ibm.portal.portletconversion.Converter. We can specify the default converter com.ibm.wps.pe.task.DefaultConverter here. This converter performs basic conversion by filtering out portlet data items whose type is not String.

        converter.classpath
        Semicolon separated list of files and folders added to the classpath in order to load the converter class.

        xmlaccess.url
        The URL to the portal XML configuration interface servlet. Use this parameter to run conversions for specific virtual portals. If this parameter is empty or missing, the default portal is used to run the conversion.

  3. cd APPSERVER_ROOT/PortalServer/ConfigEngine/.

  4. Run the portlet conversion task ConfigEngine convert-portlets .

  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. After successful conversion we can uninstall the IBM API portlet.


Example

Examples of portletconversion.properties files: 
ibmportlet.objectid=3_O4C9FI930GPE90IGU02QAR0006
jsrportlet.objectid=3_O4C9FI930GPE90IGU02QAR00G3
ibmwebapp.uid=DCE:472fb1b0-3d22-1211-0000-005da8cf7ayz:2
jsrwebapp.uid=StdPortletDataTestPortlet.war.webmod
converter=com.ibm.wps.pe.task.DefaultConverter
ibmportlet.portletname=An PortletData test portlet jsrportlet.portletname=StdPortletDataTestPortlet
ibmwebapp.uid=DCE:472fb1b0-3d22-1211-0000-005da8cf7ayz:2
jsrwebapp.uid=StdPortletDataTestPortlet.war.webmod
converter=com.ibm.wps.pe.task.DefaultConverter


Parent Converting IBM portlets (AIX IBM i Linux Solaris Windows)