installBusinessSpaceWidgets command

Use the installBusinessSpaceWidgets command to install, deploy and register widgets for use with the Business Space component.

The installBusinessSpaceWidgets command installs, deploys, and registers designated widgets contained in a compressed file or an enterprise archive (EAR) file. If widgets are already deployed, the installBusinessSpaceWidgets command refreshes the binary and registration information.

The structure of the widget compressed file contains the following items:

[ear\widgets_name.ear] one or more EAR files.
[catalog\catalog_name.xml]
[endpoints\*.xml] widget endpoints
[templates\*.zip] Templates must be in a compressed file and follow IBM Lotus Mashups template format.
[help\eclipse\plugins\*]

All folders are not required. Empty folders are valid.

The installBusinessSpaceWidgets command is run using the AdminTask object of the wsadmin scripting client.

Prerequisites

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.

Location

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

Syntax

installBusinessSpaceWidgets 
-serverName WebSphere_Portal_server_name
 -nodeName WebSphere_Portal_node_name
 -clusterName cluster_name
 -widgets widget_path
 [-save true|false]

Parameters

-serverName server_name: A required parameter that specifies the server name for the configuration. For configuring Business Space on a server, you must specify both a serverName and a nodeName.

-nodeName node_name: A required parameter that specifies the node name for the configuration. Either a serverName, nodeName, or clusterName is required. For configuring Business Space widgets on a server, you must specify both a serverName and a nodeName.

-clusterName cluster_name: A required parameter that specifies the cluster name for the configuration. For configuring Business Space widgets on a cluster, you must specify a clusterName.

-widgets widgets_path

A required parameter that specifies one of the following:

The full path for the directory that contains the compressed files or the EAR files that contain the widgets. If you specify a directory, all widgets will be installed for all compressed files and EAR files in that directory.
The full path to an individual compressed file that contains the widgets.
The full path to an individual EAR file that contains the widgets.

-save true|false: An optional parameter that indicates saving your configuration. The default value is true. If the value is false, then you must run AdminConfig.save() to save any changes to the configuration.

Examples

The following example uses the installBusinessSpaceWidgets to install, deploy, and register widgets on a server.

wsadmin -conntype SOAP -port 8880 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython 

wsadmin>AdminTask.installBusinessSpaceWidgets( [ '-nodeName', 'node_name',
'-serverName', 'server_name', '-widgets',
'install_root/BusinessSpace/registryData/product_name/widgets/MyWidget.zip' ] )

The following example uses the installBusinessSpaceWidgets to install, deploy, and register widgets on a cluster.

wsadmin -conntype SOAP -port 8880 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython 

wsadmin>AdminTask.installBusinessSpaceWidgets( [ '-clusterName', 'cluster_name',
'-widgets', 'X:/WPS/Temp' ] )

Manual steps are required for updating Business Space templates and spaces after running the installBusinessSpaceWidgets or updateBusinessSpaceWidgets command. For more information, see Process Portal or dashboard theme fails to load.