Show 

Home > Installation > Installation Steps

Installation Steps

The TIBCO OpenSpirit Adapter for Petrel can be installed using the Ocean Plug-in Manager or it can be installed using a Windows Installer (.msi file). Both methods of installation are described below.

The method used to install the OpenSpirit Adapter determines if the adapter is available to all users on the workstation it is installed on, or if it is only available to the user that performs the installation. Also, there are ways to install Ocean plug-ins on a network share that enable plug-ins to be available to all workstations and users that have been configured to use the shared plug-ins. Refer to the Petrel installation guide for a complete description of the various methods of installing Ocean plug-ins.

Support Resources

Documentation for this and other TIBCO products is available on the TIBCO Documentation site. This site is updated more frequently than any documentation that might be included with the product. To ensure that you are accessing the latest available help topics, visit:

https://docs.tibco.com

For comments or problems with this manual or the software it addresses, contact TIBCO Support:

TIBCO Community is an online destination for TIBCO customers, partners, and resident experts. It is a place to share and access the collective experience of the TIBCO community. TIBCO Community offers forums, blogs, and access to a variety of resources. To register, go to the following web address:

https://community.tibco.com

Ocean Plug-in Manager Installation Method

  1. Download the Plug-in Installer Package (.pip) file for the OpenSpirit Adapter and start Petrel.
  2. Select the Ocean Plug-in Manager option from the Petrel File menu.

 

This will open the Ocean Plug-in Manager window.

 

  1. Click on the Install plug-in button. This will open a file selector window. Select the OpenSpirit Adapter .pip file.

An installation confirmation message will appear after the plug-in has been installed. The message confirms the plug-in has been installed, but requires Petrel to be restarted in order to see and use the plug-in.

 

  1. Close the Ocean Plug-in Manager window and restart Petrel.

The plug-in can be installed in a directory outside of the Petrel installation, by modifying the "DefaultDirectory" entry in Petrel's %APPDATA%\Schlumberger\Petrel\2019\PluginManagerSettings.xml.  This is a Petrel feature.

Windows Installer Installation Method

  1. Download the plug-in installer .msi file.

  1. Make sure the Petrel application is not running. Start the installer by double clicking on the .msi file in Windows File Explorer.

  1. Follow the installation wizard and click the "Next" Button when prompted

  1. Read and accept the license agreement, then click on the "Next" Button.

  1. Make your startup optimization choice and click on the "Next" Button.

  1. Click on the Install button to begin the installation.

  1. A progress bar appears while the plug-in files are installing.

  1. Click on the Finish button when the installation is complete.

After a successful installation the OpenSpirit tool bar should appear in Petrel the next time it is launched.

The plug-in can be installed in a directory outside of the Petrel installation, by modifying the "DefaultDirectory" entry in Petrel's %PROGRAMDATA%\Schlumberger\Petrel\2020\PluginManagerSettings.xml.  This is a Petrel feature.

Windows Silent Installer Installation Method

The Windows installer can also be run in silent install mode. Silent installs do not display any user interface. Perform the following steps to silently install the Petrel Adapter.

  1. Download the plug-in installer .msi file.
  1. Make sure the Petrel application is not running.
  2. Open a Windows command window as administrator.
  3. CD to the folder containing the downloaded .msi file and execute the following command.
    msiexec /i TIB_os-toap_29.0.0_win64_Petrel2020.msi /qn

Windows Firewall Exemption Rules

Firewall exemptions are required for two application executables in order for the OpenSpirit Adapter to work properly. The executables that need exempting are:

%Ocean2020Home%Petrel.exe

%Ocean2020Home%Extensions\TIBCO\OpenSpirit Adapter 29.0.0\ZgyJobs.exe

%Ocean2020Home%Extensions\TIBCO\OpenSpirit Adapter 29.0.0\ZgyMonitor.exe

A Windows batch script is provided that contains commands to add the exemptions to your Windows firewall. The batch script is located in the OpenSpirit Adapter folder with file name FirewallExemptionRules.bat. You will need Administrator or elevated privileges in order to successfully run the script. Consult with your IT administrator about adding the rules if a firewall is being run on the system you will be using to run Petrel.

The commands in the FirewallExemptionRules.bat script specify the default location for the OpenSpirit Adapter folder. The default location is %Ocean2020Home%Extensions\TIBCO\OpenSpirit Adapter 29.0.0. The commands must be modified before running the batch script if the adapter was installed in an alternate location.

Uninstalling

The procedure for uninstalling the OpenSpirit Adapter depends on the method used to install the adapter.

Ocean Plug-in Manager Uninstall

An OpenSpirit Adapter that was installed using the Ocean Plug-in Manager is uninstalled using the Ocean Plug-in Manager. Open the Ocean Plug-in Manager from the Petrel Options menu and click on the OpenSpirit Adapter entry.

 

This will expand the OpenSpirit Adapter entry exposing an Uninstall button. Click on the Uninstall button to uninstall the plug-in.

 

A progress window will appear while the plug-in is uninstalling. Click on the Close button when the uninstall is complete. The plug-in will still appear in the installed plug-ins list. You will need to restart Petrel for the plug-in to be removed from the list and from the Petrel tool bar.

Windows Installer Uninstall

An OpenSpirit Adapter that was installed using a Windows installer (.msi file) is uninstalled using the Windows Control Panel's Program and Features list as shown in the following image.

The adapter can be removed by selecting it from the list and clicking on the Uninstall option. Make sure Petrel is not running before starting the uninstall. A confirmation prompt may appear when the Uninstall option is selected.

Click on the Yes button to proceed with the uninstall. A progress window will then appear. The progress window will go away when the uninstall completes. The OpenSpirit Adapter will not appear in Petrel when Petrel is restarted.