IBM BPM, V8.0.1, All platforms > Administer the IT infrastructure > Administer Process Portal > Administer Process Portal spaces > Remove widgets
Uninstalling custom widgets individually from Process Portal spaces
Use this procedure to uninstall a custom widget from a space that is not the only widget defined in its catalog.
You can move a widget from a space in one of the following ways:
- Disable the widget, which deregisters the widget so that it is no longer available to users but it keeps the widget code on the server.
If you want to remove a widget provided by IBM BPM Advanced, this is the way to do it. For information, see Disabling widgets in Process Portal spaces.
- Uninstalling the custom widget and the catalog that contains it, completely removes the widget (along with all of the other widgets in the catalog) and the catalog. For information, see Uninstalling custom widgets and catalogs in Process Portal spaces.
- Uninstalling the custom widget individually, removes the widget from its catalog but maintains the catalog. Do not choose this method if you are uninstalling the last widget defined in the catalog. Instead, uninstall the widget and its catalog using the procedure in Uninstalling custom widgets and catalogs in Process Portal spaces.
When the custom widget is installed, the following actions occur:
- The EAR for the widget is installed in the profile_root/installedApps/ node_name directory.
- The catalog file for the widget is added to, or updated in the profile_root/BusinessSpace/ node_name/ server_name/mm.runtime.prof/config directory. This action registers the widget. The catalog in your file is also added to the default catalog using an include tag.
- The endpoints used by the widget (if it uses them and needs custom endpoints) are added or updated in the profile_root/BusinessSpace/ node_name/ server_name/mm.runtime.prof/endpoints directory.
- The help files for the widget (if it uses the information center for its help) are added to the profile_root/config/BusinessSpace/help/eclipse/plugins directory.
When you individually uninstall a custom widget, you are deleting the widget files and removing the definition for that widget from its catalog file. You are also updating the endpoints and widget help if you include them in the uninstallation.
Procedure
- Uninstall the WAR containing the widget.
- Edit the catalog XML (widget registration) file containing the widget and remove its entries. Copy the edited file into a catalog directory.
- If the widget has help, do the following steps:
- Copy the documentation plug-in containing the help from the profile_root/config/BusinessSpace/help/eclipse/eclipse/plugins directory.
- Edit the navigation XML file and delete the entries for the widget.
- Open the doc.zip file and delete the help files for the widget. If there are hyperlinks in other files to the widget help, edit these files to delete the links.
- Copy the documentation plug-in into a help/eclipse/plugins directory.
If you have other documentation plug-ins that have hyperlinks to the plug-ins that you are deleting, you need to update the other plug-ins separately. See the final step in Create a documentation plugin for information.
- Compress the catalog and help directories. Check that the structure of the .zip file contains the following items:
- catalog\catalog_ name.xml
- help\eclipse\plugins\*
- At a command prompt, change directories to the profile_root/bin or cluster_root/bin directory.
- Enter wsadmin.bat -conntype NONE and then enter the appropriate command:
- For uninstalling the widgets from a non-clustered environment: $AdminTask updateBusinessSpaceWidgets {-nodeName node -serverName server -widgets fullpath}
- For uninstalling the widgets from a clustered environment:$AdminTask updateBusinessSpaceWidgets {-clusterName cluster -widgets fullpath}
fullpath is the name and location of the .zip file created.
For information on updateBusinessSpaceWidgets, see updateBusinessSpaceWidgets command: .
- Enter Exit
- Log in to Process Portal and delete the widget from any templates and spaces that use it. If you do not delete the widget, a placeholder image and a message that the widget is unavailable are displayed.
Remove widgets from Process Portal spaces
Related tasks:
Disabling widgets in Process Portal spaces