Migrating V7.x custom widgets to V8.5.5

If you want to use custom widgets that are used in Process Portal spaces that were developed for IBM® Business Process Manager Advanced V7.0, V7.5, or V7.5.1 in V8.5.5, you must migrate the widgets. Support for custom iWidgets is deprecated in V8.5.5.

Before you begin

The migration documentation assumes that you have experience in developing iWidgets for IBM Business Process Manager Advanced V7.0, V7.5, or V7.5.1. For information about developing iWidgets, see the V7.0 documentation at Developing widgets.

Procedure

  1. Migrate the profile that contains the custom widgets.
  2. Uninstall the custom widget EAR.
    Important: Your V7.x widgets might use Dojo. The instance of the IBM Dojo Toolkit that is used by widgets in IBM BPM V8.5.5 is based on V1.6.1 of the Dojo toolkit. However, this bundled version might be updated as needed over time. Updates might include entire new Dojo versions and specific defect fixes. Compatibility of future Dojo versions is defined by the Dojo project.
  3. Update the code in your widget if the upgrade to the iWidget specification impacts your widgets. The following table shows the iWidget specification that applies to each version of IBM Business Process Manager Advanced.
    IBM Business Process Manager Advanced version iWidget specification version
    7.0 2.0
    7.5.x 2.1
    V8.5.5 2.1
    You can download V2.1 of the iWidget specification from http://public.dhe.ibm.com/software/dw/lotus/mashups/developer/iwidget-spec-v2.1.pdf. Review the specification for changes and deprecations to see how the upgrade impacts your widgets.
  4. To package the widgets:
    1. Create an ear directory. Copy the .ear files that contain the migrated widget definition files and widget implementation files into the ear directory.
    2. Create a catalog directory and copy the catalog XML (widget registration) files into it.
    3. Create an endpoints directory and copy the endpoint registration files into it if there are any endpoint registration files.
    4. Create a help directory and copy the help plug-ins into it if there are any help plug-ins.
    5. Compress the ear, catalog, endpoints, and help directories into a .zip file. Check that the structure of the compressed file contains the following items:
      • ear\widgets_name.ear (one or more EAR files)
      • catalog\catalog_name.xml
      • endpoints\*.xml
      • help\eclipse\plugins\*
  5. At the command line, change directories to the profile_root/bin or cluster_root/bin directory.
  6. Enter wsadmin.bat -conntype NONE and then enter the appropriate command:
    • For a non-clustered environment:
      • Jython command:
        AdminTask.updateBusinessSpaceWidgets('{-nodeName node -serverName server -widgets fullpath}')
      • Jacl command:
        $AdminTask updateBusinessSpaceWidgets {-nodeName node -serverName server -widgets fullpath}
    • For a clustered environment:
      • Jython command:
        AdminTask.updateBusinessSpaceWidgets('{-clusterName cluster -widgets fullpath}')
      • Jacl command:
        $AdminTask updateBusinessSpaceWidgets {-clusterName cluster -widgets fullpath}
    Fullpath is the name and location of the .zip file or parent folder you created.

    For more information on updateBusinessSpaceWidgets, see updateBusinessSpaceWidgets command.

  7. Enter Exit to complete the migration.
  8. Restart the server or cluster.