updateBusinessSpaceWidgets command

Use the updateBusinessSpaceWidgets command to update previously configured widgets and their endpoints, catalogs, templates, and help plugins.

This command updates widget binary files, catalog files, endpoint files, templates, and help plug-ins for widgets that have been previously installed and configured for Business Space.

The updateBusinessSpaceWidgets command updates widget files in a designated compressed file or an enterprise archive (EAR) file. 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 updateBusinessSpaceWidgets 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

updateBusinessSpaceWidgets 
-serverName WebSphere_Portal_server_name
 -nodeName WebSphere_Portal_node_name
	-clusterName cluster_name
 [-widgets widget_path]
 [-endpoints endpoint_path]
 [-catalogs catalog_path]
 [-templates template_path]
 [-helpplugins help_path]
 [-noWidgets true|false]
 [-noEndpoints true|false]
 [-noCatalogs true|false]
 [-noTemplates true|false]
[-noHelp true|false]
[-save true|false]

Parameters

-serverName server_name: A required parameter that specifies the server name for the configuration. For configuring Business Space widgets 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 on a cluster, you must specify a clusterName.

-widgets widget_path: An optional parameter that specifies the full path for the directory where widget enterprise archive (EAR) files or widget compressed files are located or the full path to a specific EAR file or widget compressed file.

-endpoints endpoint_path: A parameter that specifies the full path for the directory where the widget endpoint files are located or the full path to a specific endpoint file.

-catalogs catalog_path: An optional parameter that specifies the full path for the directory that contains the widget catalog files or the full path to a specific catalog file.

-templates template_path: An optional parameter that specifies the full path for the directory that contains the widget template files or the full path to a specific template file.

-helpplugins help_path: An optional parameter that specifies the full path for the directory that contains the widget online help plugin files or the full path to a specific widget online help plugin file.

-noWidgets true|false: An optional parameter that specifies that you do not want to update the widget EAR files that are contained within the widgets compressed file.

-noEndpoints true|false: An optional parameter that specifies that you do not want to update the specified endpoint files that are contained in the widgets compressed file.

-noCatalogs true|false: An optional parameter that specifies that you do not want to update the catalog definition files that are contained in the widgets compressed file.

-noTemplates true|false: An optional parameter that specifies that you do not want to update the templates that are contained in the widgets compressed file.

-noHelp true|false: An optional parameter that specifies that you do not want to update the help files that are contained in the widgets compressed file.

-save true|false: A optional parameter that indicates saving your configuration. The default value is true. If the value is false, you must run AdminConfig.save() at the end of the command to save your changes.

Examples

The following example uses the updateBusinessSpaceWidgets to update widgets on a cluster.

wsadmin -user admin -password admin -lang jython 

wsadmin>AdminTask.updateBusinessSpaceWidgets( [ '-clusterName', 'cluster_name',
'-widgets', 'widget_path' ] )

The following example uses the updateBusinessSpaceWidgets to update widgets on a server.

wsadmin -user admin -password admin -lang jython 

wsadmin>AdminTask.updateBusinessSpaceWidgets( [ '-nodeName', 'node_name',
'-serverName', 'server_name', '-widgets', 'widget_path' ] )

Manual steps are required for updating templates and spaces after running the installBusinessSpaceWidgets or updateBusinessSpaceWidgets command. For more information, see Updating templates and spaces after installing or updating widgets.