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

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.

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 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 widgets on a cluster, you must specify a clusterName.

-widgets widgets_path

A 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

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

Optional parameters

–save true|false

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

Examples

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

• Jython example:

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

• Jacl example:

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

• Jython example:

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

• Jacl example:

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