Uninstalling custom widgets and catalogs in Heritage Process Portal spaces

You can uninstall a custom catalog and the widgets that it contains from a space.

Before you begin

The uninstallBusinessSpaceWidgets command is used to perform some tasks in this topic. The command is run using the AdminTask object of the wsadmin scripting client.

The following conditions must be met:

Run the command on the deployment manager node.
Run the command in the connected mode, that is, do not use the wsadmin -conntype none option.
You must connect with a user ID that has WebSphere® Application Server administrator privileges.

Start the wsadmin scripting client from the deployment_manager_profile/bin directory.

About this task

Custom widgets are widgets that your organization has developed. You can remove a custom widget 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 that is provided by the product, this is the way to do it. For more information, see Disabling widgets in Heritage Process Portal spaces.
Uninstalling the custom widget and the catalog that contains it, which removes all of the widgets in the catalog and the catalog.
Uninstalling the custom widget individually, which removes the widget from its catalog but maintains the catalog. Do not choose this way if you are uninstalling the last widget defined in the catalog. Instead, install the widget and its catalog. For information, see Uninstalling custom widgets individually from Heritage Process Portal spaces.

When a 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 documentation for its help) are added to the profile_root/config/BusinessSpace/help/eclipse/plugins directory.

When you uninstall one or more custom widgets and their catalog, you are deleting the widget files and the catalog file, removing the reference to the catalog file from the default catalog, and updating the documentation to remove the help plug-ins for the widgets. A command is provided for the uninstallation.

Procedure

If you do not have the .zip file that was used install the custom widget and its catalog, you need to re-create it:
1. Create an ear directory. Copy the EAR files for your custom widgets into the directory.
2. Create a catalog directory and copy the catalog XML (widget registration) file into it.
3. Create a help directory and copy the documentation plug-ins into it if there are any documentation plug-ins.
  Note: If you have other documentation plug-ins that have hyperlinks to the documentation plug-ins that you are deleting, you will need to update those plug-ins separately. For more information, see the final step in Deprecated: Creating a documentation plug-in.
4. Compress the .ear file, catalog, and help directories. Check that the structure of the .zip file contains the following items:
  - ear\widgets_name.ear (one or more EAR files)
  - 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 uninstallBusinessSpaceWidgets {-nodeName node -serverName server -widgets fullpath}
- For uninstalling the widgets from a clustered environment:$AdminTask uninstallBusinessSpaceWidgets {-clusterName cluster -widgets fullpath}
fullpath is the name and location of the .zip file that you created.
For information on uninstallBusinessSpaceWidgets, see uninstallBusinessSpaceWidgets command.
The command deletes the EARs, catalog file, and documentation plug-ins contained in the .zip file.
Enter Exit
Log in to Heritage 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.