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

installBusinessSpace command

Use the installBusinessSpace command to set up the Business Space component on your IBM Business Process Manager environment.

The installBusinessSpace command can be used to install the Business Space enterprise archive (EAR) files in your runtime environment. It can also be used to update the configuration without installing Business Space.

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

Either serverName and nodeName, or clusterName are required.

-serverName server_name

A parameter that specifies the server name for the configuration.

For configuring Business Space on a server, you must specify both the serverName and the nodeName parameters.

-nodeName node_name

A parameter that specifies the node name for the configuration.

For configuring Business Space on a server, you must specify both theserverName and the nodeName parameters

-clusterName cluster_name

A parameter that specifies the cluster name for the configuration.

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

Optional parameters

–noWidgets true|false

An optional parameter that if set to true prevents the product widgets from being installed on the deployment target. Then, if you want to install widgets, you must use the installBusinessSpaceWidgets command after the Business Space configuration has completed successfully. The default value is false.

–save true|false

An optional parameter that indicates saving your configuration changes. The default value is false.

–configUpdateOnly true|false

An optional parameter that if set to true only updates the configuration, without installing the Business Space enterprise archive (EAR) files on the deployment target. The default value is false.

–configEnv environment

An optional parameter that updates the profile settings to set the Business Space environment.

You might use this parameter in the following sitations:

• If you have augmented your IBM Business Process Manager Standard profile to include IBM Business Monitor, WebSphere Operational Decision Management, or IBM Case Manager, and you find that when you log onto Process Portal, you do not see the globe icon that allows users to switch to Business Space spaces that include widgets from these products. In this situation, you must run the installBusinessSpace command with –configEnv bpm_adv and -configUpdateOnly true to enable the globe icon. See Examples: Enabling the globe icon in Process Portal later in this topic for an example.

• If, after creating a profile for a product that includes Business Space (such as WebSphere Business Monitor, IBM Case Manager, or WebSphere Operational Decision Management) in an environment that includes an IBM Business Process Manager product, the Process Portal is available instead of Business Space. In this situation, manually switch back to the Business Space environment by completing the following steps:

  1. Update the Business Space profile setting by running the installBusinessSpace wsadmin command with the -configEnv business_space -configUpdateOnly true -save true parameters.

     For example, if your Business Space is configured on a cluster named myCluster, use one of the following commands:

     • Using Jacl:

       $AdminTask installBusinessSpace {-clusterName myCluster -configUpdateOnly true -configEnv bspace2 -save true}
       

     • Using Jython

       AdminTask.installBusinessSpace(['-clusterName', 'myCluster', '-configUpdateOnly', 'true', '-configEnv', 'bspace2', '-save', 'true'])
       

     If your Business Space is configured on a server, you must use the -ServerName and -nodeName parameters instead of the -clusterName parameter.

  2. Edit the install_root\profiles\application_server_name\BusinessSpace\node_name\server_name\mm.runtime.prof\public\oobLoadedStatus.properties file and add the following three lines to it:

     importTemplates.txt=true
     importSpaces.txt=true
     importThemes.txt=true
     

  3. Start or restart the server.

  4. Clear the browser cache and then log into Business Space.

Examples: Installing Business Space

The following example uses the installBusinessSpace command to install Business Space EAR files on a server.

• Jython example:

  AdminTask.installBusinessSpace('[-nodeName myNode -serverName
   myServer -save true]')
  

• Jacl example:

  $AdminTask installBusinessSpace {-nodeName myNode -serverName
   myServer -save true}
  

The following example uses the installBusinessSpace to install Business Space EAR files on a cluster.

• Jython example:

  AdminTask.installBusinessSpace('[-clusterName myCluster -save true]')
  

• Jacl example:

  $AdminTask installBusinessSpace {-clusterName myCluster -save true}
  

Examples: Enabling the globe icon in Process Portal

The following cluster example uses the installBusinessSpace to enable the globe icon in Process Portal, that allows users to switch to spaces that include IBM Business Monitor widgets. This example does not install the Business Space EAR files. This example only applies if you have augmented your IBM Business Process Manager Standard profile to include IBM Business Monitor.

Jacl example:

wsadmin>$AdminTask installBusinessSpace {-clusterName myCluster -configUpdateOnly true -configEnv bpm_adv -save true}

Jython example:

AdminTask.installBusinessSpace(['-clusterName', 'myCluster', '-configUpdateOnly', 'true', '-configEnv', 'bpm_adv', '-save', 'true'])

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