BW6 Commons Plug-in Installation

Purpose of the document is to describe installation and deinstallation procedure of BW6 Commons plug-in on existing TIBCO BusinessWorks 6 environment.


Table of Contents

  1. Installation Components
  2. Design-time Installation
  3. Run-time Installation
  4. Extend BWCE Docker Image
  5. Uninstallation

Installation Components

The majority of TIBCO BusinessWorks plug-ins provide two installation profiles - design-time and run-time. Design-time components enable BW developers to model business flows inside TIBCO BusinessStudio IDE. Run-time bundles are responsible for execution of processes inside IDE for testing and debug purposes, as well as on production servers to handle real requests. Application developers are advised to leverage both design-time and run-time components. On the other hand, we recommend system administrators to install only run-time part on BW servers.

Design-time Installation

Follow below steps to install design-time bundles into TIBCO BusinessStudio.

  1. Use your favourite tool to unpack bw6-commons-${version}-${os}.zip archive.

    $ unzip bw6-commons-6.0.0-linux.zip
  2. Open TIBCO BusinessStudio and select Help > Install New Software... from main menu.
  3. Click on Add... button to create new local plug-in repository.
  4. Choose unique name (for example BW6 Commons) and click on Local... button. Navigate to directory where you have extracted ZIP archive and select design-time subfolder. Compare your results with below screenshot. Finally, press OK.

    BusinessStudio local plug-in repository.

  5. Deselect Group items by category... checkbox, select all available features and hit Next twice.
  6. Carefully review license agreement, accept it and click Finish to proceed with installation.
  7. After restart of TIBCO BusinessStudio, you should have access to Commons palette.

    BusinessStudio with Commons palette.

Run-time Installation

Run-time packages can be installed in either graphical or silent mode. BW6 developers usually prefer GUI, whereas system administrators relay on silent mode to automate installaton on multiple servers without X11 windows. Users just need to know absolute path to TIBCO home with BusinessWorks 6 environment. On Microsoft Windows, the default value of TIBCO_HOME is C:\Program Files\tibco\bw6.

Note

Install Java Cryptography Extension in JRE used by BusinessWorks engine (default ${TIBCO_HOME}/tibcojre64/${JAVA_VERSION}/) to enable unlimited cryptography policy. If you skip this step, you will not be able to leverage strong encryption ciphers.

Graphical Mode

Follow below steps to install run-time bundles in graphical mode.

  1. Make sure that TIBCO BusinessStudio and all related AppNodes are shutdown.
  2. Use your favourite tool to unpack bw6-commons-${version}-${os}.zip archive.

    $ unzip bw6-commons-6.0.0-linux.zip
  3. Go to run-time subfolder and start universal installer. Please make sure that you have Java Runtime Environment version 1.8 installed on the system and added to PATH environment variable.

    $ ./installer.sh
  4. Main installer window will open. Carefully review license agreement, accept it and click Install Plug-in to continue.
  5. Browse and select target TIBCO home directory.
  6. Click Finish to proceed with installation.

    Universal installer GUI.

  7. Once installation process completes, close all windows.

Silent Mode

Follow below steps to install run-time bundles in silent mode.

  1. Make sure that TIBCO BusinessStudio and all related AppNodes are shutdown.
  2. Use your favourite tool to unpack bw6-commons-${version}-${os}.zip archive.

    $ unzip bw6-commons-6.0.0-linux.zip
  3. Open new terminal window and export TIBCO_HOME environment variable. It should represent absolute path where you have installed BusinessWorks 6 software.

    $ export TIBCO_HOME=/opt/tibco/bw650
  4. Go to run-time subfolder of extracted ZIP arfhive and execute universal installer in silent mode. Please make sure that you have Java Runtime Environment version 1.8 installed on the system and added to PATH environment variable.

    $ ./install-silent.sh

Extend BWCE Docker Image

Users running BusinessWorks Container Edition may extend base Docker image with Commons Plug-ins. All you need to do is to copy bw6-commons-${version}-container.zip to ${buildpack-repo}/resources/addons/plugins and run createDockerImage.sh script. For more details, consult TIBCO documentation.

Uninstallation

Deinstallation of BW6 Commons plug-in may involve design-time and run-time components depending on previously chosen installation profile.

Design-time Deinstallation

Follow below steps to uninstall design-time bundles from TIBCO BusinessStudio.

  1. Open TIBCO BusinessStudio and select Help > Install Details from main menu.
  2. Select all features whole name starts with TIBCO ActiveMatrix BusinessWorks Commons.

    Uninstall Commons Plug-in from IDE.

  3. Press Uninstall button and when new window pops-up click Finish. Finally, restart IDE for changes to take effect.

Run-time Deinstallation

Uninstallation of run-time packages can be accomplished in either graphical or silent mode.

Graphical Mode

Follow below steps to uninstall run-time bundles in graphical mode.

  1. Make sure that TIBCO BusinessStudio and all related AppNodes are shutdown.
  2. Use your favourite tool to unpack bw6-commons-${version}-${os}.zip archive.

    $ unzip bw6-commons-6.0.0-linux.zip
  3. Go to run-time subfolder and start universal installer. Please make sure that you have Java Runtime Environment version 1.8 installed on the system and added to PATH environment variable.

    $ ./installer.sh
  4. Main installer window will open. Carefully review license agreement, accept it and click Uninstall Plug-in to continue.
  5. Browse and select target TIBCO home directory.
  6. Click Finish to proceed with destallation.
  7. Once removal process completes, close all windows.

Silent Mode

Follow below steps to uninstall run-time bundles in silent mode.

  1. Make sure that TIBCO BusinessStudio and all related AppNodes are shutdown.
  2. Use your favourite tool to unpack bw6-commons-${version}-${os}.zip archive.

    $ unzip bw6-commons-6.0.0-linux.zip
  3. Open new terminal window and export TIBCO_HOME environment variable. It should represent absolute path where you have installed BusinessWorks 6 software.

    $ export TIBCO_HOME=/opt/tibco/bw650
  4. Go to run-time subfolder of extracted ZIP arfhive and execute universal installer in silent mode. Please make sure that you have Java Runtime Environment version 1.8 installed on the system and added to PATH environment variable.

    $ ./uninstall-silent.sh