openspirit adapter for petrel installation guide · pdf filetibco openspirit® adapter for...

TIBCO OpenSpirit® Adapter for Petrel Installation Guide

Software Release 23.0.0

July 2014

ii

Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENTIS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.

This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.

TIBCO, The Power of Now, TIBCO OpenSpirit Adaptor for Petrel are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.

All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE RELEASE NOTES FOR THE AVAILABILITY OF THIS SOFTWARE VERSIONON A SPECIFIC OPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

Copyright©2000-2014 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

Contents | 3

OpenSpirit Adapter for Petrel Installation Guide

Contents Installation Steps .............................................................................................................. 5

Ocean Plug-in Manager Installation Method ................................................................. 5

Windows Installer Installation Method .......................................................................... 8

Windows Firewall Exemption Rules ........................................................................... 12

Uninstalling ................................................................................................................ 13

Ocean Plug-in Manager Uninstall ............................................................................ 13

Windows Installer Uninstall .................................................................................... 15

Installation Files ............................................................................................................. 17

4 | Installation Prerequisites


Installation Prerequisites The TIBCO OpenSpirit Adapter for Petrel requires the following software be installed prior to installation:

• Petrel 2014.x • OpenSpirit runtime v4.0.3 (or newer)

The supported Windows versions are those that Petrel supports. Refer to the Petrel application documentation for operating system and hardware requirements.

The TIBCO OpenSpirit Adapter for Petrel requires an Ocean plug-in license feature named "OCEAN_TIB_OPENSPIRITADAPTER" to be available and it requires a Petrel Geoscience Core license.

The public key token for the TIBCO OpenSpirit Adapter for Petrel is: 6fff63412f6928a6. ECCN: US origin, EAR99

Installation Steps | 5


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.

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.

6 | Installation Steps


This will open the Ocean Plug-in Manager window.



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



4. 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\2014\PluginManagerSettings.xml. This is a Petrel feature.

Windows Installer Installation Method 1. Download the plug-in installer .msi file.

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



3. Follow the installation wizard and click the Next button when prompted



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

5. Make your startup optimization choice and click on the Next button.



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



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

8. 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\2014\PluginManagerSettings.xml. This is a Petrel feature.

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:

%Ocean2014Home%\Petrel.exe %Ocean2014Home%\Extensions\TIBCO\OpenSpirit Adapter 23.0.0\ZgyJobs.exe %Ocean2014Home%\Extensions\TIBCO\OpenSpirit Adapter 23.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 %Ocean2014Home%\Extensions\TIBCO\OpenSpirit Adapter 23.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 Unistall 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.

Installation Files | 17


Installation Files The following files are created by the OpenSpirit Adapter installation. These files and the OpenSpirit Adapter folder are removed during uninstall. The default OpenSpirit Adapter installation folder is: %OCEAN2014HOME%\Extensions\TIBCO\OpenSpirit Adapter

FirewallExemptions.bat GISAttributeSchemaExample.xml GisAttributesSchema.xsd GisExtendedAttributes.dll help.chm Launcher.ico log4net.dll LogNameToLogMnemonic.xml ModuleInstalled.ico OceanUserPluginConfig.config OpenSpirit.App.Ocean.Interfaces.dll OpenSpirit.App.Ocean.Petrel2014.dll OpenSpirit.App.Ocean.PlugIn.dll OpenSpirit.App.Ocean.PlugIn.Plugin_Manifest.xml OpenSpirit.App.Opf.dll OpenSpirit.App.Opf.Impl_31.dll OpenSpirit.dll OpenSpirit.NET.dll OpenSpiritGroupingConfig.config OpenSpiritHorizonTypeAndPetrelTemplate.xml OpenSpiritLogKindToPetrelMnemonic.xml OpenSpiritPlugin.config OpenSpiritPlugin.log4net OpenSpiritStudioFindLoader.dll OpenSpiritTitle.gif OpenSpiritWellSymbolsToWellType.xml Plugin.xml Support.config WellTypesToOpenSpiritWellSymbol.xml ZgyJobs.exe ZgyMonitor.exe ZgyMonitor.exe.config

openspirit adapter for petrel installation guide · pdf filetibco openspirit® adapter for...

Documents