IBM Business Process Manager, V8.0.1, All platforms > Reference > Commands and scripts > Commands (wsadmin scripting)

updateBusinessSpaceWidgets command

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

The updateBusinessSpaceWidgets 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.

After using the command, save your changes to the master configuration using one of the following commands:

• For Jython:

  AdminConfig.save()
  

• For Jacl:

  $AdminConfig save
  

If the application server is not running, supply the -conntype NONE option when running this command.

Required parameters

-serverName server_name

A 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 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 parameter that specifies the cluster name for the configuration.

For configuring Business Space on a cluster, you must specify a clusterName.

Optional parameters

-widgets widget_path

A 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

A 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

A 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

A 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

Specifies that you do not want to update the widget EAR files that are contained within the widgets compressed file.

–noEndpoints true|false

Specifies that you do not want to update the specified endpoint files that are contained in the widgets compressed file.

–noCatalogs true|false

Specifies that you do not want to update the catalog definition files that are contained in the widgets compressed file.

–noTemplates true|false

Specifies that you do not want to update the templates that are contained in the widgets compressed file.

–noHelp true|false

Specifies that you do not want to update the help files that are contained in the widgets compressed file.

–save true|false

A parameter that indicates saving your configuration. The default value is true.

Examples

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

Jython example:

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

Jacl example:

$AdminTask updateBusinessSpaceWidgets {-clusterName cluster_name
 -widgets  widget_path}

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

Jython example:

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

Jacl example:

$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: .

Parent topic: Commands (wsadmin scripting)

Related information:

Obtaining online help using wsadmin scripting
Administrative command invocation syntax using wsadmin scripting
Use the wsadmin scripting tool
Jython script library